yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 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;
   9
  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.LeafNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  30 import org.opendaylight.yangtools.yang.data.api.schema.stream.SchemaAwareNormalizedNodeStreamWriter;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
  47 import org.opendaylight.yangtools.yang.data.util.LeafInterner;
  48 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  50 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
  51
  52 /**
  53  *
  54  * Implementation of {@link NormalizedNodeStreamWriter}, which constructs
  55  * immutable instances of {@link NormalizedNode}s.
  56  * <p>
  57  * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)}
  58  * where resulting NormalizedNode will be stored in supplied result object.
  59  *
  60  * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)},
  61  * where all created nodes will be written to this builder.
  62  *
  63  *
  64  */
  65 public class ImmutableNormalizedNodeStreamWriter implements SchemaAwareNormalizedNodeStreamWriter {
  66
  67     @SuppressWarnings("rawtypes")
  68     private final Deque<NormalizedNodeContainerBuilder> builders = new ArrayDeque<>();
  69     private DataSchemaNode nextSchema;
  70
  71     @SuppressWarnings("rawtypes")
  72     protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeContainerBuilder topLevelBuilder) {
  73         builders.push(topLevelBuilder);
  74     }
  75
  76     protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeResult result) {
  77         this(new NormalizedNodeResultBuilder(result));
  78     }
  79
  80     /**
  81      * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied
  82      * {@link NormalizedNode}s and writes them to supplied builder as child nodes.
  83      * <p>
  84      * Type of supplied {@link NormalizedNodeContainerBuilder} affects,
  85      * which events could be emitted in order to ensure proper construction of
  86      * data.
  87      *
  88      * @param builder Builder to which data will be written.
  89      * @return {@link NormalizedNodeStreamWriter} which writes data
  90      */
  91     public static final NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
  92         return new ImmutableNormalizedNodeStreamWriter(builder);
  93     }
  94
  95     /**
  96      * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top
  97      * level {@link NormalizedNode} (type of NormalizedNode) is determined by first
  98      * start event.
  99      * <p>
 100      * Result is built when {@link #endNode()} associated with that start event
 101      * is emitted.
 102      * <p>
 103      * Writer properly creates also nested {@link NormalizedNode} instances,
 104      * if their are supported inside the scope of first event.
 105      * <p>
 106      * This method is useful for clients, which knows there will be one
 107      * top level node written, but does not know which type of {@link NormalizedNode}
 108      * will be written.
 109      *
 110      * @param result {@link NormalizedNodeResult} object which will hold result value.
 111      * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
 112      */
 113     public static final NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
 114         return new ImmutableNormalizedNodeStreamWriter(result);
 115     }
 116
 117     @SuppressWarnings("rawtypes")
 118     private NormalizedNodeContainerBuilder getCurrent() {
 119         return builders.peek();
 120     }
 121
 122     @SuppressWarnings("rawtypes")
 123     private void enter(final NormalizedNodeContainerBuilder next) {
 124         builders.push(next);
 125         nextSchema = null;
 126     }
 127
 128     @SuppressWarnings("unchecked")
 129     protected void writeChild(final NormalizedNode<?, ?> child) {
 130         getCurrent().addChild(child);
 131     }
 132
 133     @Override
 134     @SuppressWarnings({"rawtypes","unchecked"})
 135     public void endNode() {
 136         final NormalizedNodeContainerBuilder finishedBuilder = builders.poll();
 137         Preconditions.checkState(finishedBuilder != null, "Node which should be closed does not exists.");
 138         final NormalizedNodeContainerBuilder current = getCurrent();
 139         Preconditions.checkState(current != null, "Reached top level node, which could not be closed in this writer.");
 140         final NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
 141         current.addChild(product);
 142         nextSchema = null;
 143     }
 144
 145     @Override
 146     public void leafNode(final NodeIdentifier name, final Object value) {
 147         checkDataNodeContainer();
 148
 149         final LeafNode<Object> sample = ImmutableNodes.leafNode(name, value);
 150         final LeafNode<Object> node;
 151         if (nextSchema instanceof LeafSchemaNode) {
 152             node = LeafInterner.forSchema((LeafSchemaNode)nextSchema).intern(sample);
 153         } else {
 154             node = sample;
 155         }
 156
 157         writeChild(node);
 158         nextSchema = null;
 159     }
 160
 161     @Override
 162     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 163         checkDataNodeContainer();
 164         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = UNKNOWN_SIZE == childSizeHint ?
 165                 InterningLeafSetNodeBuilder.create(nextSchema) :
 166                     InterningLeafSetNodeBuilder.create(nextSchema, childSizeHint);
 167         builder.withNodeIdentifier(name);
 168         enter(builder);
 169     }
 170
 171     @Override
 172     public void leafSetEntryNode(final Object value) {
 173         Preconditions.checkArgument(getCurrent() instanceof ImmutableLeafSetNodeBuilder<?>);
 174         @SuppressWarnings("unchecked")
 175         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableLeafSetNodeBuilder<Object>) getCurrent());
 176         builder.withChildValue(value);
 177         nextSchema = null;
 178     }
 179
 180     @Override
 181     public void anyxmlNode(final NodeIdentifier name, final Object value) {
 182         checkDataNodeContainer();
 183         nextSchema = null;
 184     }
 185
 186     @Override
 187     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
 188         checkDataNodeContainer();
 189
 190         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = UNKNOWN_SIZE == childSizeHint ?
 191                 ImmutableContainerNodeBuilder.create() : ImmutableContainerNodeBuilder.create(childSizeHint);
 192         enter(builder.withNodeIdentifier(name));
 193     }
 194
 195     @Override
 196     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) {
 197         checkDataNodeContainer();
 198
 199         Preconditions.checkArgument(nextSchema instanceof YangModeledAnyXmlSchemaNode,
 200                 "Schema of this node should be instance of YangModeledAnyXmlSchemaNode");
 201         final DataContainerNodeAttrBuilder<NodeIdentifier, YangModeledAnyXmlNode> builder = UNKNOWN_SIZE == childSizeHint ? ImmutableYangModeledAnyXmlNodeBuilder
 202                 .create((YangModeledAnyXmlSchemaNode) nextSchema) : ImmutableYangModeledAnyXmlNodeBuilder.create(
 203                 (YangModeledAnyXmlSchemaNode) nextSchema, childSizeHint);
 204         enter(builder.withNodeIdentifier(name));
 205     }
 206
 207     @Override
 208     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
 209         checkDataNodeContainer();
 210
 211         final CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> builder = UNKNOWN_SIZE == childSizeHint ?
 212                 ImmutableUnkeyedListNodeBuilder.create() : ImmutableUnkeyedListNodeBuilder.create(childSizeHint);
 213         enter(builder.withNodeIdentifier(name));
 214     }
 215
 216     @Override
 217     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
 218         Preconditions.checkArgument((getCurrent() instanceof NormalizedNodeResultBuilder)
 219                 || getCurrent() instanceof ImmutableUnkeyedListNodeBuilder);
 220         final DataContainerNodeAttrBuilder<NodeIdentifier, UnkeyedListEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
 221                 ImmutableUnkeyedListEntryNodeBuilder.create() : ImmutableUnkeyedListEntryNodeBuilder.create(childSizeHint);
 222         enter(builder.withNodeIdentifier(name));
 223     }
 224
 225     @Override
 226     public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
 227         checkDataNodeContainer();
 228
 229         final CollectionNodeBuilder<MapEntryNode, MapNode> builder = UNKNOWN_SIZE == childSizeHint ?
 230                 ImmutableMapNodeBuilder.create() : ImmutableMapNodeBuilder.create(childSizeHint);
 231         enter(builder.withNodeIdentifier(name));
 232     }
 233
 234     @Override
 235     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
 236         if(!(getCurrent() instanceof NormalizedNodeResultBuilder)) {
 237             Preconditions.checkArgument(getCurrent() instanceof ImmutableMapNodeBuilder || getCurrent() instanceof ImmutableOrderedMapNodeBuilder);
 238         }
 239
 240         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
 241                 ImmutableMapEntryNodeBuilder.create() : ImmutableMapEntryNodeBuilder.create(childSizeHint);
 242         enter(builder.withNodeIdentifier(identifier));
 243     }
 244
 245     @Override
 246     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
 247         checkDataNodeContainer();
 248
 249         final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> builder = UNKNOWN_SIZE == childSizeHint ?
 250                 ImmutableOrderedMapNodeBuilder.create() : ImmutableOrderedMapNodeBuilder.create(childSizeHint);
 251         enter(builder.withNodeIdentifier(name));
 252     }
 253
 254     @Override
 255     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 256         checkDataNodeContainer();
 257
 258         final DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> builder = UNKNOWN_SIZE == childSizeHint ?
 259                 ImmutableChoiceNodeBuilder.create() : ImmutableChoiceNodeBuilder.create(childSizeHint);
 260         enter(builder.withNodeIdentifier(name));
 261     }
 262
 263     @Override
 264     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 265         checkDataNodeContainer();
 266         Preconditions.checkArgument(!(getCurrent() instanceof ImmutableAugmentationNodeBuilder));
 267         enter(Builders.augmentationBuilder().withNodeIdentifier(identifier));
 268     }
 269
 270     private void checkDataNodeContainer() {
 271         @SuppressWarnings("rawtypes")
 272         final
 273         NormalizedNodeContainerBuilder current = getCurrent();
 274         if (!(current instanceof NormalizedNodeResultBuilder)) {
 275             Preconditions.checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
 276         }
 277     }
 278
 279     @SuppressWarnings("rawtypes")
 280     private static final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
 281
 282         private final NormalizedNodeResult result;
 283
 284         public NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
 285             this.result = result;
 286         }
 287
 288         @Override
 289         public NormalizedNodeBuilder withValue(final Object value) {
 290             throw new UnsupportedOperationException();
 291         }
 292
 293         @Override
 294         public NormalizedNode build() {
 295             throw new IllegalStateException("Can not close NormalizedNodeResult");
 296         }
 297
 298         @Override
 299         public NormalizedNodeContainerBuilder withNodeIdentifier(final PathArgument nodeIdentifier) {
 300             throw new UnsupportedOperationException();
 301         }
 302
 303         @Override
 304         public NormalizedNodeContainerBuilder withValue(final Collection value) {
 305             throw new UnsupportedOperationException();
 306         }
 307
 308         @Override
 309         public NormalizedNodeContainerBuilder addChild(final NormalizedNode child) {
 310             result.setResult(child);
 311             return this;
 312         }
 313
 314         @Override
 315         public NormalizedNodeContainerBuilder removeChild(final PathArgument key) {
 316             throw new UnsupportedOperationException();
 317         }
 318
 319     }
 320
 321     @Override
 322     public void flush() {
 323         // no-op
 324     }
 325
 326     @Override
 327     public void close() {
 328         // no-op
 329     }
 330
 331     @Override
 332     public void nextDataSchemaNode(final DataSchemaNode schema) {
 333         nextSchema = Preconditions.checkNotNull(schema);
 334     }
 335 }