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.data.api.YangInstanceIdentifier.AugmentationIdentifier;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
18 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
46 * Implementation of {@link NormalizedNodeStreamWriter}, which constructs
47 * immutable instances of {@link NormalizedNode}s.
49 * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)}
50 * where resulting NormalizedNode will be stored in supplied result object.
52 * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)},
53 * where all created nodes will be written to this builder.
57 public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
59 @SuppressWarnings("rawtypes")
60 private final Deque<NormalizedNodeContainerBuilder> builders = new ArrayDeque<>();
62 @SuppressWarnings("rawtypes")
63 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeContainerBuilder topLevelBuilder) {
64 builders.push(topLevelBuilder);
67 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeResult result) {
68 this(new NormalizedNodeResultBuilder(result));
72 * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied
73 * {@link NormalizedNode}s and writes them to supplied builder as child nodes.
75 * Type of supplied {@link NormalizedNodeContainerBuilder} affects,
76 * which events could be emitted in order to ensure proper construction of
79 * @param builder Builder to which data will be written.
80 * @return {@link NormalizedNodeStreamWriter} which writes data
82 public static final NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
83 return new ImmutableNormalizedNodeStreamWriter(builder);
88 * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top
89 * level {@link NormalizedNode} (type of NormalizedNode) is determined by first
92 * Result is built when {@link #endNode()} associated with that start event
95 * Writer properly creates also nested {@link NormalizedNode} instances,
96 * if their are supported inside the scope of first event.
98 * This method is useful for clients, which knows there will be one
99 * top level node written, but does not know which type of {@link NormalizedNode}
102 * @param result {@link NormalizedNodeResult} object which will hold result value.
103 * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
105 public static final NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
106 return new ImmutableNormalizedNodeStreamWriter(result);
110 @SuppressWarnings("rawtypes")
111 private NormalizedNodeContainerBuilder getCurrent() {
112 return builders.peek();
115 @SuppressWarnings("rawtypes")
116 private void enter(final NormalizedNodeContainerBuilder next) {
120 @SuppressWarnings("unchecked")
121 protected void writeChild(final NormalizedNode<?, ?> child) {
122 getCurrent().addChild(child);
126 @SuppressWarnings({"rawtypes","unchecked"})
127 public void endNode() {
128 final NormalizedNodeContainerBuilder finishedBuilder = builders.poll();
129 Preconditions.checkState(finishedBuilder != null, "Node which should be closed does not exists.");
130 final NormalizedNodeContainerBuilder current = getCurrent();
131 Preconditions.checkState(current != null, "Reached top level node, which could not be closed in this writer.");
132 final NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
133 current.addChild(product);
137 public void leafNode(final NodeIdentifier name, final Object value) {
138 checkDataNodeContainer();
139 writeChild(ImmutableNodes.leafNode(name, value));
143 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
144 checkDataNodeContainer();
145 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = UNKNOWN_SIZE == childSizeHint ?
146 ImmutableLeafSetNodeBuilder.create() : ImmutableLeafSetNodeBuilder.create(childSizeHint);
147 builder.withNodeIdentifier(name);
152 public void leafSetEntryNode(final Object value) {
153 Preconditions.checkArgument(getCurrent() instanceof ImmutableLeafSetNodeBuilder<?>);
154 @SuppressWarnings("unchecked")
155 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableLeafSetNodeBuilder<Object>) getCurrent());
156 builder.withChildValue(value);
160 public void anyxmlNode(final NodeIdentifier name, final Object value) {
161 checkDataNodeContainer();
165 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
166 checkDataNodeContainer();
168 final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = UNKNOWN_SIZE == childSizeHint ?
169 ImmutableContainerNodeBuilder.create() : ImmutableContainerNodeBuilder.create(childSizeHint);
170 enter(builder.withNodeIdentifier(name));
174 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
175 checkDataNodeContainer();
177 final CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> builder = UNKNOWN_SIZE == childSizeHint ?
178 ImmutableUnkeyedListNodeBuilder.create() : ImmutableUnkeyedListNodeBuilder.create(childSizeHint);
179 enter(builder.withNodeIdentifier(name));
183 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
184 Preconditions.checkArgument(getCurrent() instanceof ImmutableUnkeyedListNodeBuilder);
186 final DataContainerNodeAttrBuilder<NodeIdentifier, UnkeyedListEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
187 ImmutableUnkeyedListEntryNodeBuilder.create() : ImmutableUnkeyedListEntryNodeBuilder.create(childSizeHint);
188 enter(builder.withNodeIdentifier(name));
192 public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
193 checkDataNodeContainer();
195 final CollectionNodeBuilder<MapEntryNode, MapNode> builder = UNKNOWN_SIZE == childSizeHint ?
196 ImmutableMapNodeBuilder.create() : ImmutableMapNodeBuilder.create(childSizeHint);
197 enter(builder.withNodeIdentifier(name));
201 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
202 if(!(getCurrent() instanceof NormalizedNodeResultBuilder)) {
203 Preconditions.checkArgument(getCurrent() instanceof ImmutableMapNodeBuilder || getCurrent() instanceof ImmutableOrderedMapNodeBuilder);
206 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
207 ImmutableMapEntryNodeBuilder.create() : ImmutableMapEntryNodeBuilder.create(childSizeHint);
208 enter(builder.withNodeIdentifier(identifier));
212 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
213 checkDataNodeContainer();
215 final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> builder = UNKNOWN_SIZE == childSizeHint ?
216 ImmutableOrderedMapNodeBuilder.create() : ImmutableOrderedMapNodeBuilder.create(childSizeHint);
217 enter(builder.withNodeIdentifier(name));
221 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
222 checkDataNodeContainer();
224 final DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> builder = UNKNOWN_SIZE == childSizeHint ?
225 ImmutableChoiceNodeBuilder.create() : ImmutableChoiceNodeBuilder.create(childSizeHint);
226 enter(builder.withNodeIdentifier(name));
230 public void startAugmentationNode(final AugmentationIdentifier identifier) {
231 checkDataNodeContainer();
232 Preconditions.checkArgument(!(getCurrent() instanceof ImmutableAugmentationNodeBuilder));
233 enter(Builders.augmentationBuilder().withNodeIdentifier(identifier));
236 private void checkDataNodeContainer() {
237 @SuppressWarnings("rawtypes")
239 NormalizedNodeContainerBuilder current = getCurrent();
240 if (!(current instanceof NormalizedNodeResultBuilder)) {
241 Preconditions.checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
245 @SuppressWarnings("rawtypes")
246 private static final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
248 private final NormalizedNodeResult result;
250 public NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
251 this.result = result;
255 public NormalizedNodeBuilder withValue(final Object value) {
256 throw new UnsupportedOperationException();
260 public NormalizedNode build() {
261 throw new IllegalStateException("Can not close NormalizedNodeResult");
265 public NormalizedNodeContainerBuilder withNodeIdentifier(final PathArgument nodeIdentifier) {
266 throw new UnsupportedOperationException();
270 public NormalizedNodeContainerBuilder withValue(final Collection value) {
271 throw new UnsupportedOperationException();
275 public NormalizedNodeContainerBuilder addChild(final NormalizedNode child) {
276 result.setResult(child);
281 public NormalizedNodeContainerBuilder removeChild(final PathArgument key) {
282 throw new UnsupportedOperationException();
288 public void flush() {
293 public void close() {