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