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