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 static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static java.util.Objects.requireNonNull;
14 import java.io.IOException;
15 import java.util.ArrayDeque;
16 import java.util.Deque;
17 import javax.xml.transform.dom.DOMSource;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyxmlSchemaNode;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnydataNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
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.ImmutableOrderedLeafSetNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
45 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
48 * Implementation of {@link NormalizedNodeStreamWriter}, which constructs immutable instances of
49 * {@link NormalizedNode}s.
52 * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)} where resulting
53 * NormalizedNode will be stored in supplied result object.
56 * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)}, where all created nodes will be
57 * written to this builder.
60 * This class is not final for purposes of customization, normal users should not need to subclass it.
62 public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
63 @SuppressWarnings("rawtypes")
64 private final Deque<NormalizedNodeBuilder> builders = new ArrayDeque<>();
66 private DataSchemaNode nextSchema;
68 @SuppressWarnings("rawtypes")
69 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeBuilder topLevelBuilder) {
70 builders.push(topLevelBuilder);
73 protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeResult result) {
74 this(new NormalizedNodeResultBuilder(result));
78 * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied {@link NormalizedNode}s
79 * and writes them to supplied builder as child nodes.
82 * Type of supplied {@link NormalizedNodeContainerBuilder} affects, which events could be emitted in order
83 * to ensure proper construction of data.
85 * @param builder Builder to which data will be written.
86 * @return {@link NormalizedNodeStreamWriter} which writes data
88 public static @NonNull NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
89 return new ImmutableNormalizedNodeStreamWriter(builder);
93 * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top-level {@link NormalizedNode}
94 * (type of NormalizedNode) is determined by first start event.
97 * Result is built when {@link #endNode()} associated with that start event is emitted.
100 * Writer properly creates also nested {@link NormalizedNode} instances, if their are supported inside the scope
101 * of the first event.
104 * This method is useful for clients, which knows there will be one top-level node written, but does not know which
105 * type of {@link NormalizedNode} will be written.
107 * @param result {@link NormalizedNodeResult} object which will hold result value.
108 * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
110 public static @NonNull NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
111 return result instanceof NormalizedNodeMetadataResult ? from((NormalizedNodeMetadataResult) result)
112 : new ImmutableNormalizedNodeStreamWriter(result);
116 * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top-level {@link NormalizedNode}
117 * (type of NormalizedNode) is determined by first start event.
120 * Result is built when {@link #endNode()} associated with that start event is emitted.
123 * Writer properly creates also nested {@link NormalizedNode} instances, if their are supported inside the scope
124 * of the first event.
127 * This method is useful for clients, which knows there will be one top-level node written, but does not know which
128 * type of {@link NormalizedNode} will be written.
130 * @param result {@link NormalizedNodeResult} object which will hold result value.
131 * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
133 public static @NonNull NormalizedNodeStreamWriter from(final NormalizedNodeMetadataResult result) {
134 return new ImmutableMetadataNormalizedNodeStreamWriter(result);
138 public void startLeafNode(final NodeIdentifier name) {
139 checkDataNodeContainer();
140 enter(name, leafNodeBuilder(nextSchema));
145 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
146 checkDataNodeContainer();
147 enter(name, UNKNOWN_SIZE == childSizeHint ? InterningLeafSetNodeBuilder.create(nextSchema)
148 : InterningLeafSetNodeBuilder.create(nextSchema, childSizeHint));
152 public void startLeafSetEntryNode(final NodeWithValue<?> name) {
153 final NormalizedNodeBuilder<?, ?, ?> current = current();
154 checkArgument(current instanceof ImmutableLeafSetNodeBuilder
155 || current instanceof ImmutableOrderedLeafSetNodeBuilder || current instanceof NormalizedNodeResultBuilder,
156 "LeafSetEntryNode is not valid for parent %s", current);
157 enter(name, leafsetEntryNodeBuilder());
162 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
163 checkDataNodeContainer();
164 enter(name, Builders.orderedLeafSetBuilder());
168 public void startAnyxmlNode(final NodeIdentifier name) {
169 checkDataNodeContainer();
170 enter(name, ImmutableAnyXmlNodeBuilder.create());
175 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
176 checkDataNodeContainer();
177 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableContainerNodeBuilder.create()
178 : ImmutableContainerNodeBuilder.create(childSizeHint));
182 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) {
183 checkDataNodeContainer();
185 checkArgument(nextSchema instanceof YangModeledAnyxmlSchemaNode,
186 "Schema of this node should be instance of YangModeledAnyxmlSchemaNode");
187 final YangModeledAnyxmlSchemaNode anyxmlSchema = (YangModeledAnyxmlSchemaNode) nextSchema;
188 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableYangModeledAnyXmlNodeBuilder.create(anyxmlSchema)
189 : ImmutableYangModeledAnyXmlNodeBuilder.create(anyxmlSchema, childSizeHint));
193 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
194 checkDataNodeContainer();
195 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableUnkeyedListNodeBuilder.create()
196 : ImmutableUnkeyedListNodeBuilder.create(childSizeHint));
200 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
201 final NormalizedNodeBuilder<?, ?, ?> current = current();
202 checkArgument(current instanceof ImmutableUnkeyedListNodeBuilder
203 || current instanceof NormalizedNodeResultBuilder);
204 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableUnkeyedListEntryNodeBuilder.create()
205 : ImmutableUnkeyedListEntryNodeBuilder.create(childSizeHint));
209 public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
210 checkDataNodeContainer();
211 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableMapNodeBuilder.create()
212 : ImmutableMapNodeBuilder.create(childSizeHint));
216 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
217 final NormalizedNodeBuilder<?, ?, ?> current = current();
218 checkArgument(current instanceof ImmutableMapNodeBuilder || current instanceof ImmutableOrderedMapNodeBuilder
219 || current instanceof NormalizedNodeResultBuilder);
221 enter(identifier, UNKNOWN_SIZE == childSizeHint ? ImmutableMapEntryNodeBuilder.create()
222 : ImmutableMapEntryNodeBuilder.create(childSizeHint));
226 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
227 checkDataNodeContainer();
228 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableOrderedMapNodeBuilder.create()
229 : ImmutableOrderedMapNodeBuilder.create(childSizeHint));
233 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
234 checkDataNodeContainer();
235 enter(name, UNKNOWN_SIZE == childSizeHint ? ImmutableChoiceNodeBuilder.create()
236 : ImmutableChoiceNodeBuilder.create(childSizeHint));
240 public void startAugmentationNode(final AugmentationIdentifier identifier) {
241 checkDataNodeContainer();
242 checkArgument(!(current() instanceof ImmutableAugmentationNodeBuilder));
243 enter(identifier, Builders.augmentationBuilder());
247 public void flush() {
252 public void close() {
257 public void nextDataSchemaNode(final DataSchemaNode schema) {
258 nextSchema = requireNonNull(schema);
262 public void scalarValue(final Object value) {
263 currentScalar().withValue(value);
267 public void domSourceValue(final DOMSource value) {
268 currentScalar().withValue(value);
272 @SuppressWarnings({ "rawtypes", "unchecked" })
273 public void endNode() {
274 final NormalizedNodeBuilder finishedBuilder = builders.poll();
275 checkState(finishedBuilder != null, "Node which should be closed does not exists.");
276 final NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
283 public boolean startAnydataNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
284 checkDataNodeContainer();
285 enter(name, ImmutableAnydataNodeBuilder.create(objectModel));
286 // We support all object models
291 * Add a child not to the currently-open builder.
293 * @param child A new child
294 * @throws NullPointerException if {@code child} is null
295 * @throws IllegalStateException if there is no open builder
297 @SuppressWarnings({ "rawtypes", "unchecked" })
298 protected final void writeChild(final NormalizedNode<?, ?> child) {
299 final NormalizedNodeContainerBuilder current = currentContainer();
300 checkState(current != null, "Reached top level node, which could not be closed in this writer.");
301 current.addChild(requireNonNull(child));
304 // Exposed for ImmutableMetadataNormalizedNodeStreamWriter
305 @SuppressWarnings("rawtypes")
306 void enter(final PathArgument identifier, final NormalizedNodeBuilder next) {
307 builders.push(next.withNodeIdentifier(identifier));
311 // Exposed for ImmutableMetadataNormalizedNodeStreamWriter
312 protected final NormalizedNodeBuilder popBuilder() {
313 return builders.pop();
316 final void reset(final NormalizedNodeResultBuilder builder) {
319 builders.push(builder);
322 private <T> ImmutableLeafNodeBuilder<T> leafNodeBuilder(final DataSchemaNode schema) {
323 final InterningLeafNodeBuilder<T> interning = InterningLeafNodeBuilder.forSchema(schema);
324 return interning != null ? interning : leafNodeBuilder();
327 <T> ImmutableLeafNodeBuilder<T> leafNodeBuilder() {
328 return new ImmutableLeafNodeBuilder<>();
331 <T> ImmutableLeafSetEntryNodeBuilder<T> leafsetEntryNodeBuilder() {
332 return ImmutableLeafSetEntryNodeBuilder.create();
335 private void checkDataNodeContainer() {
336 @SuppressWarnings("rawtypes")
337 final NormalizedNodeContainerBuilder current = currentContainer();
338 if (!(current instanceof NormalizedNodeResultBuilder)) {
339 checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
343 @SuppressWarnings("rawtypes")
344 private NormalizedNodeBuilder current() {
345 return builders.peek();
348 @SuppressWarnings("rawtypes")
349 private NormalizedNodeContainerBuilder currentContainer() {
350 final NormalizedNodeBuilder current = current();
351 if (current == null) {
354 checkState(current instanceof NormalizedNodeContainerBuilder, "%s is not a node container", current);
355 return (NormalizedNodeContainerBuilder) current;
358 @SuppressWarnings("rawtypes")
359 private NormalizedNodeBuilder currentScalar() {
360 final NormalizedNodeBuilder current = current();
361 checkState(!(current instanceof NormalizedNodeContainerBuilder), "Unexpected node container %s", current);