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