Bug 808: Added representation for unordered and ordered lists.
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / builder / impl / ImmutableOrderedMapNodeBuilder.java
1 /*
2  * Copyright (c) 2013 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.yangtools.yang.data.impl.schema.builder.impl;
9
10 import java.util.LinkedHashMap;
11 import java.util.List;
12 import java.util.Map;
13
14 import org.opendaylight.yangtools.concepts.Immutable;
15 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifier;
17 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
18 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
20 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
21 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
22 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableNormalizedNode;
23
24 import com.google.common.base.Optional;
25 import com.google.common.collect.Iterables;
26
27 public class ImmutableOrderedMapNodeBuilder
28         implements CollectionNodeBuilder<MapEntryNode, OrderedMapNode> {
29
30     private Map<InstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> value;
31     private InstanceIdentifier.NodeIdentifier nodeIdentifier;
32     private boolean dirty = false;
33
34     protected ImmutableOrderedMapNodeBuilder() {
35         this.value = new LinkedHashMap<>();
36         this.dirty = false;
37     }
38
39     protected ImmutableOrderedMapNodeBuilder(final ImmutableOrderedMapNode node) {
40         this.value = node.children;
41         this.dirty = true;
42     }
43
44     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> create() {
45         return new ImmutableOrderedMapNodeBuilder();
46     }
47
48     public static CollectionNodeBuilder<MapEntryNode, OrderedMapNode> create(final OrderedMapNode node) {
49         if (!(node instanceof ImmutableOrderedMapNode)) {
50             throw new UnsupportedOperationException(String.format("Cannot initialize from class %s", node.getClass()));
51         }
52
53         return new ImmutableOrderedMapNodeBuilder((ImmutableOrderedMapNode) node);
54     }
55
56     private void checkDirty() {
57         if (dirty) {
58             value = new LinkedHashMap<>(value);
59             dirty = false;
60         }
61     }
62
63     @Override
64     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withChild(final MapEntryNode child) {
65         checkDirty();
66         this.value.put(child.getIdentifier(), child);
67         return this;
68     }
69
70     @Override
71     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withoutChild(final InstanceIdentifier.PathArgument key) {
72         checkDirty();
73         this.value.remove(key);
74         return this;
75     }
76
77     @Override
78     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withValue(final List<MapEntryNode> value) {
79         // TODO replace or putAll ?
80         for (final MapEntryNode mapEntryNode : value) {
81             withChild(mapEntryNode);
82         }
83
84         return this;
85     }
86
87     @Override
88     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> withNodeIdentifier(final InstanceIdentifier.NodeIdentifier nodeIdentifier) {
89         this.nodeIdentifier = nodeIdentifier;
90         return this;
91     }
92
93     @Override
94     public OrderedMapNode build() {
95         dirty = true;
96         return new ImmutableOrderedMapNode(nodeIdentifier, value);
97     }
98
99     @Override
100     public CollectionNodeBuilder<MapEntryNode, OrderedMapNode> addChild(
101             final MapEntryNode child) {
102         return withChild(child);
103     }
104
105
106     @Override
107     public NormalizedNodeContainerBuilder<NodeIdentifier, PathArgument, MapEntryNode, OrderedMapNode> removeChild(
108             final PathArgument key) {
109         return withoutChild(key);
110     }
111
112     protected static final class ImmutableOrderedMapNode extends AbstractImmutableNormalizedNode<InstanceIdentifier.NodeIdentifier, Iterable<MapEntryNode>> implements Immutable,OrderedMapNode {
113
114         private final Map<InstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> children;
115
116         ImmutableOrderedMapNode(final InstanceIdentifier.NodeIdentifier nodeIdentifier,
117                          final Map<InstanceIdentifier.NodeIdentifierWithPredicates, MapEntryNode> children) {
118             super(nodeIdentifier, Iterables.unmodifiableIterable(children.values()));
119             this.children = children;
120         }
121
122         @Override
123         public Optional<MapEntryNode> getChild(final InstanceIdentifier.NodeIdentifierWithPredicates child) {
124             return Optional.fromNullable(children.get(child));
125         }
126
127         @Override
128         protected int valueHashCode() {
129             return children.hashCode();
130         }
131
132         @Override
133         protected boolean valueEquals(final AbstractImmutableNormalizedNode<?, ?> other) {
134             return children.equals(((ImmutableOrderedMapNode) other).children);
135         }
136
137         @Override
138         public MapEntryNode getChild(final int position) {
139             return Iterables.get(getValue(), position);
140         }
141
142         @Override
143         public int getSize() {
144             return children.size();
145         }
146     }
147 }