2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema;
10 import com.google.common.base.Preconditions;
11 import java.util.ArrayDeque;
12 import java.util.Collection;
13 import java.util.Deque;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
19 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
31 import org.opendaylight.yangtools.yang.data.api.schema.stream.SchemaAwareNormalizedNodeStreamWriter;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
49 import org.opendaylight.yangtools.yang.data.util.LeafInterner;
50 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
56 * Implementation of {@link NormalizedNodeStreamWriter}, which constructs
57 * immutable instances of {@link NormalizedNode}s.
59 * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)}
60 * where resulting NormalizedNode will be stored in supplied result object.
62 * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)},
63 * where all created nodes will be written to this builder.
67 public class ImmutableNormalizedNodeStreamWriter implements SchemaAwareNormalizedNodeStreamWriter {
69 @SuppressWarnings("rawtypes")
70 private final Deque<NormalizedNodeContainerBuilder> builders = new ArrayDeque<>();
71 private DataSchemaNode nextSchema;
73 @SuppressWarnings("rawtypes")
74 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeContainerBuilder topLevelBuilder) {
75 builders.push(topLevelBuilder);
78 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeResult result) {
79 this(new NormalizedNodeResultBuilder(result));
83 * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied
84 * {@link NormalizedNode}s and writes them to supplied builder as child nodes.
86 * Type of supplied {@link NormalizedNodeContainerBuilder} affects,
87 * which events could be emitted in order to ensure proper construction of
90 * @param builder Builder to which data will be written.
91 * @return {@link NormalizedNodeStreamWriter} which writes data
93 public static NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
94 return new ImmutableNormalizedNodeStreamWriter(builder);
98 * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top
99 * level {@link NormalizedNode} (type of NormalizedNode) is determined by first
102 * Result is built when {@link #endNode()} associated with that start event
105 * Writer properly creates also nested {@link NormalizedNode} instances,
106 * if their are supported inside the scope of first event.
108 * This method is useful for clients, which knows there will be one
109 * top level node written, but does not know which type of {@link NormalizedNode}
112 * @param result {@link NormalizedNodeResult} object which will hold result value.
113 * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
115 public static NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
116 return new ImmutableNormalizedNodeStreamWriter(result);
119 @SuppressWarnings("rawtypes")
120 private NormalizedNodeContainerBuilder getCurrent() {
121 return builders.peek();
124 @SuppressWarnings("rawtypes")
125 private void enter(final NormalizedNodeContainerBuilder next) {
130 @SuppressWarnings("unchecked")
131 protected void writeChild(final NormalizedNode<?, ?> child) {
132 getCurrent().addChild(child);
136 @SuppressWarnings({"rawtypes","unchecked"})
137 public void endNode() {
138 final NormalizedNodeContainerBuilder finishedBuilder = builders.poll();
139 Preconditions.checkState(finishedBuilder != null, "Node which should be closed does not exists.");
140 final NormalizedNodeContainerBuilder current = getCurrent();
141 Preconditions.checkState(current != null, "Reached top level node, which could not be closed in this writer.");
142 final NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
143 current.addChild(product);
148 public void leafNode(final NodeIdentifier name, final Object value) {
149 checkDataNodeContainer();
151 final LeafNode<Object> sample = ImmutableNodes.leafNode(name, value);
152 final LeafNode<Object> node;
153 if (nextSchema instanceof LeafSchemaNode) {
154 node = LeafInterner.forSchema((LeafSchemaNode)nextSchema).intern(sample);
164 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
165 checkDataNodeContainer();
166 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = UNKNOWN_SIZE == childSizeHint ?
167 InterningLeafSetNodeBuilder.create(nextSchema) :
168 InterningLeafSetNodeBuilder.create(nextSchema, childSizeHint);
169 builder.withNodeIdentifier(name);
174 public void leafSetEntryNode(final QName name, final Object value) {
175 if (getCurrent() instanceof ImmutableOrderedLeafSetNodeBuilder) {
176 @SuppressWarnings("unchecked")
177 ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableOrderedLeafSetNodeBuilder<Object>) getCurrent());
178 builder.withChildValue(value);
179 } else if (getCurrent() instanceof ImmutableLeafSetNodeBuilder) {
180 @SuppressWarnings("unchecked")
181 ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableLeafSetNodeBuilder<Object>) getCurrent());
182 builder.withChildValue(value);
184 throw new IllegalArgumentException("LeafSetEntryNode is not valid for parent " + getCurrent());
191 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
192 checkDataNodeContainer();
193 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = Builders.orderedLeafSetBuilder();
194 builder.withNodeIdentifier(name);
199 public void anyxmlNode(final NodeIdentifier name, final Object value) {
200 checkDataNodeContainer();
205 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
206 checkDataNodeContainer();
208 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = UNKNOWN_SIZE == childSizeHint ?
209 ImmutableContainerNodeBuilder.create() : ImmutableContainerNodeBuilder.create(childSizeHint);
210 enter(builder.withNodeIdentifier(name));
214 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) {
215 checkDataNodeContainer();
217 Preconditions.checkArgument(nextSchema instanceof YangModeledAnyXmlSchemaNode,
218 "Schema of this node should be instance of YangModeledAnyXmlSchemaNode");
219 final DataContainerNodeAttrBuilder<NodeIdentifier, YangModeledAnyXmlNode> builder = UNKNOWN_SIZE == childSizeHint ? ImmutableYangModeledAnyXmlNodeBuilder
220 .create((YangModeledAnyXmlSchemaNode) nextSchema) : ImmutableYangModeledAnyXmlNodeBuilder.create(
221 (YangModeledAnyXmlSchemaNode) nextSchema, childSizeHint);
222 enter(builder.withNodeIdentifier(name));
226 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
227 checkDataNodeContainer();
229 final CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> builder = UNKNOWN_SIZE == childSizeHint ?
230 ImmutableUnkeyedListNodeBuilder.create() : ImmutableUnkeyedListNodeBuilder.create(childSizeHint);
231 enter(builder.withNodeIdentifier(name));
235 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
236 Preconditions.checkArgument((getCurrent() instanceof NormalizedNodeResultBuilder)
237 || getCurrent() instanceof ImmutableUnkeyedListNodeBuilder);
238 final DataContainerNodeAttrBuilder<NodeIdentifier, UnkeyedListEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
239 ImmutableUnkeyedListEntryNodeBuilder.create() : ImmutableUnkeyedListEntryNodeBuilder.create(childSizeHint);
240 enter(builder.withNodeIdentifier(name));
244 public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
245 checkDataNodeContainer();
247 final CollectionNodeBuilder<MapEntryNode, MapNode> builder = UNKNOWN_SIZE == childSizeHint ?
248 ImmutableMapNodeBuilder.create() : ImmutableMapNodeBuilder.create(childSizeHint);
249 enter(builder.withNodeIdentifier(name));
253 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
254 if (!(getCurrent() instanceof NormalizedNodeResultBuilder)) {
255 Preconditions.checkArgument(getCurrent() instanceof ImmutableMapNodeBuilder || getCurrent() instanceof ImmutableOrderedMapNodeBuilder);
258 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
259 ImmutableMapEntryNodeBuilder.create() : ImmutableMapEntryNodeBuilder.create(childSizeHint);
260 enter(builder.withNodeIdentifier(identifier));
264 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
265 checkDataNodeContainer();
267 final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> builder = UNKNOWN_SIZE == childSizeHint ?
268 ImmutableOrderedMapNodeBuilder.create() : ImmutableOrderedMapNodeBuilder.create(childSizeHint);
269 enter(builder.withNodeIdentifier(name));
273 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
274 checkDataNodeContainer();
276 final DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> builder = UNKNOWN_SIZE == childSizeHint ?
277 ImmutableChoiceNodeBuilder.create() : ImmutableChoiceNodeBuilder.create(childSizeHint);
278 enter(builder.withNodeIdentifier(name));
282 public void startAugmentationNode(final AugmentationIdentifier identifier) {
283 checkDataNodeContainer();
284 Preconditions.checkArgument(!(getCurrent() instanceof ImmutableAugmentationNodeBuilder));
285 enter(Builders.augmentationBuilder().withNodeIdentifier(identifier));
288 private void checkDataNodeContainer() {
289 @SuppressWarnings("rawtypes")
291 NormalizedNodeContainerBuilder current = getCurrent();
292 if (!(current instanceof NormalizedNodeResultBuilder)) {
293 Preconditions.checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
297 @SuppressWarnings("rawtypes")
298 private static final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
300 private final NormalizedNodeResult result;
302 public NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
303 this.result = result;
307 public NormalizedNodeBuilder withValue(final Object value) {
308 throw new UnsupportedOperationException();
312 public NormalizedNode build() {
313 throw new IllegalStateException("Can not close NormalizedNodeResult");
317 public NormalizedNodeContainerBuilder withNodeIdentifier(final PathArgument nodeIdentifier) {
318 throw new UnsupportedOperationException();
322 public NormalizedNodeContainerBuilder withValue(final Collection value) {
323 throw new UnsupportedOperationException();
327 public NormalizedNodeContainerBuilder addChild(final NormalizedNode child) {
328 result.setResult(child);
333 public NormalizedNodeContainerBuilder removeChild(final PathArgument key) {
334 throw new UnsupportedOperationException();
340 public void flush() {
345 public void close() {
350 public void nextDataSchemaNode(final DataSchemaNode schema) {
351 nextSchema = Preconditions.checkNotNull(schema);