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