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;
12 import java.io.IOException;
13 import java.util.ArrayDeque;
14 import java.util.Deque;
15 import java.util.List;
17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
21 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
24 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
25 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
26 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
27 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
36 * Implementation of {@link NormalizedNodeStreamWriter}, which constructs
37 * immutable instances of {@link NormalizedNode}s.
39 * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)}
40 * where resulting NormalizedNode will be stored in supplied result object.
42 * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)},
43 * where all created nodes will be written to this builder.
47 public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
49 @SuppressWarnings("rawtypes")
50 private final Deque<NormalizedNodeContainerBuilder> builders = new ArrayDeque<>();
52 @SuppressWarnings("rawtypes")
53 private ImmutableNormalizedNodeStreamWriter( final NormalizedNodeContainerBuilder topLevelBuilder) {
54 builders.push(topLevelBuilder);
58 * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied
59 * {@link NormalizedNode}s and writes them to supplied builder as child nodes.
61 * Type of supplied {@link NormalizedNodeContainerBuilder} affects,
62 * which events could be emitted in order to ensure proper construction of
65 * @param builder Builder to which data will be written.
66 * @return {@link NormalizedNodeStreamWriter} which writes data
68 public static final NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
69 return new ImmutableNormalizedNodeStreamWriter(builder);
74 * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top
75 * level {@link NormalizedNode} (type of NormalizedNode) is determined by first
78 * Result is built when {@link #endNode()} associated with that start event
81 * Writer properly creates also nested {@link NormalizedNode} instances,
82 * if their are supported inside the scope of first event.
84 * This method is useful for clients, which knows there will be one
85 * top level node written, but does not know which type of {@link NormalizedNode}
89 * @param result {@link NormalizedNodeResult} object which will hold result value.
90 * @return {@link NormalizedNodeStreamWriter} whcih will write item to supplied result holder.
92 public static final NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
93 return new ImmutableNormalizedNodeStreamWriter(new NormalizedNodeResultBuilder(result));
97 @SuppressWarnings("rawtypes")
98 private NormalizedNodeContainerBuilder getCurrent() {
99 return builders.peek();
102 @SuppressWarnings("rawtypes")
103 private void enter(final NormalizedNodeContainerBuilder next) {
107 @SuppressWarnings("unchecked")
108 private void writeChild(final NormalizedNode<?, ?> child) {
109 getCurrent().addChild(child);
113 @SuppressWarnings({"rawtypes","unchecked"})
114 public void endNode() {
115 final NormalizedNodeContainerBuilder finishedBuilder = builders.poll();
116 Preconditions.checkState(finishedBuilder != null, "Node which should be closed does not exists.");
117 NormalizedNodeContainerBuilder current = getCurrent();
118 Preconditions.checkState(current != null, "Reached top level node, which could not be closed in this writer.");
119 NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
120 current.addChild(product);
124 public void leafNode(final NodeIdentifier name, final Object value) throws IllegalArgumentException {
125 checkDataNodeContainer();
126 writeChild(ImmutableNodes.leafNode(name, value));
130 public void startLeafSet(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
131 checkDataNodeContainer();
132 ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = Builders.leafSetBuilder();
133 builder.withNodeIdentifier(name);
138 public void leafSetEntryNode(final Object value) throws IllegalArgumentException {
139 Preconditions.checkArgument(getCurrent() instanceof ImmutableLeafSetNodeBuilder<?>);
140 @SuppressWarnings("unchecked")
141 ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableLeafSetNodeBuilder<Object>) getCurrent());
142 builder.withChildValue(value);
146 public void anyxmlNode(final NodeIdentifier name, final Object value) throws IllegalArgumentException {
147 checkDataNodeContainer();
153 public void startContainerNode(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
154 checkDataNodeContainer();
155 enter(Builders.containerBuilder().withNodeIdentifier(name));
159 public void startUnkeyedList(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
160 checkDataNodeContainer();
161 enter(Builders.unkeyedListBuilder().withNodeIdentifier(name));
165 public void startUnkeyedListItem(final NodeIdentifier name,final int childSizeHint) throws IllegalStateException {
166 Preconditions.checkArgument(getCurrent() instanceof ImmutableUnkeyedListNodeBuilder);
167 enter(Builders.unkeyedListEntryBuilder().withNodeIdentifier(name));
171 public void startMapNode(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
172 checkDataNodeContainer();
173 enter(Builders.mapBuilder().withNodeIdentifier(name));
177 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier,final int childSizeHint) throws IllegalArgumentException {
178 if(!(getCurrent() instanceof NormalizedNodeResultBuilder)) {
179 Preconditions.checkArgument(getCurrent() instanceof ImmutableMapNodeBuilder || getCurrent() instanceof ImmutableOrderedMapNodeBuilder);
181 enter(Builders.mapEntryBuilder().withNodeIdentifier(identifier));
185 public void startOrderedMapNode(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
186 checkDataNodeContainer();
187 enter(Builders.orderedMapBuilder().withNodeIdentifier(name));
191 public void startChoiceNode(final NodeIdentifier name,final int childSizeHint) throws IllegalArgumentException {
192 checkDataNodeContainer();
193 enter(Builders.choiceBuilder().withNodeIdentifier(name));
196 public void startAugmentationNode(final AugmentationIdentifier identifier) throws IllegalArgumentException {
197 checkDataNodeContainer();
198 Preconditions.checkArgument(!(getCurrent() instanceof ImmutableAugmentationNodeBuilder));
199 enter(Builders.augmentationBuilder().withNodeIdentifier(identifier));
202 private void checkDataNodeContainer() {
203 @SuppressWarnings("rawtypes")
204 NormalizedNodeContainerBuilder current = getCurrent();
205 if(!(current instanceof NormalizedNodeResultBuilder)) {
206 Preconditions.checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
210 @SuppressWarnings("rawtypes")
211 private static final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
213 private final NormalizedNodeResult result;
215 public NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
216 this.result = result;
220 public NormalizedNodeBuilder withValue(final Object value) {
221 throw new UnsupportedOperationException();
225 public NormalizedNode build() {
226 throw new IllegalStateException("Can not close NormalizedNodeResult");
230 public NormalizedNodeContainerBuilder withNodeIdentifier(final PathArgument nodeIdentifier) {
231 throw new UnsupportedOperationException();
235 public NormalizedNodeContainerBuilder withValue(final List value) {
236 throw new UnsupportedOperationException();
240 public NormalizedNodeContainerBuilder addChild(final NormalizedNode child) {
241 result.setResult(child);
246 public NormalizedNodeContainerBuilder removeChild(final PathArgument key) {
247 throw new UnsupportedOperationException();
253 public void flush() {
258 public void close() throws IOException {
259 // TODO Auto-generated method stub