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