Merge branch 'blueprint' from controller
[mdsal.git] / binding / mdsal-binding-dom-adapter / src / main / java / org / opendaylight / mdsal / binding / dom / adapter / LazySerializedContainerNode.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.mdsal.binding.dom.adapter;
9
10 import static java.util.Objects.requireNonNull;
11
12 import java.util.Optional;
13 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
14 import org.opendaylight.mdsal.binding.dom.codec.util.AbstractBindingLazyContainerNode;
15 import org.opendaylight.yangtools.yang.binding.DataObject;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
19 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
21 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
23
24 /**
25  * FIXME: This is a bit of functionality which should really live in binding-dom-codec, but for to happen we need
26  *        to extends BindingNormalizedNodeCodecRegistry with the concept of a routing context -- which would be
27  *        deprecated, as we want to move to actions in the long term.
28  */
29 class LazySerializedContainerNode extends AbstractBindingLazyContainerNode<DataObject,
30         BindingNormalizedNodeCodecRegistry> implements BindingDataAware {
31
32     private LazySerializedContainerNode(final QName identifier, final DataObject binding,
33             final BindingNormalizedNodeCodecRegistry registry) {
34         super(NodeIdentifier.create(identifier), binding, requireNonNull(registry));
35     }
36
37     static ContainerNode create(final SchemaPath rpcName, final DataObject data,
38             final BindingNormalizedNodeCodecRegistry codec) {
39         return data == null ? null : new LazySerializedContainerNode(rpcName.getLastComponent(), data, codec);
40     }
41
42     static ContainerNode withContextRef(final SchemaPath rpcName, final DataObject data,
43             final LeafNode<?> contextRef, final BindingNormalizedNodeCodecRegistry codec) {
44         return new WithContextRef(rpcName.getLastComponent(), data, contextRef, codec);
45     }
46
47     @Override
48     public final DataObject bindingData() {
49         return getDataObject();
50     }
51
52     @Override
53     protected final ContainerNode computeContainerNode(final BindingNormalizedNodeCodecRegistry context) {
54         return context.toNormalizedNodeRpcData(getDataObject());
55     }
56
57     /**
58      * Lazy Serialized Node with pre-cached serialized leaf holding routing information.
59      */
60     private static final class WithContextRef extends LazySerializedContainerNode {
61         private final LeafNode<?> contextRef;
62
63         protected WithContextRef(final QName identifier, final DataObject binding, final LeafNode<?> contextRef,
64                 final BindingNormalizedNodeCodecRegistry registry) {
65             super(identifier, binding, registry);
66             this.contextRef = requireNonNull(contextRef);
67         }
68
69         @Override
70         public Optional<DataContainerChild<? extends PathArgument, ?>> getChild(final PathArgument child) {
71             // Use pre-cached value of routing field and do not run full serialization if we are accessing it.
72             return contextRef.getIdentifier().equals(child) ?  Optional.of(contextRef) : super.getChild(child);
73         }
74     }
75 }