yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableMetadataNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ClassToInstanceMap;
  15 import com.google.common.collect.ImmutableMap;
  16 import java.io.IOException;
  17 import java.util.ArrayDeque;
  18 import java.util.Deque;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.concepts.ObjectExtensions;
  21 import org.opendaylight.yangtools.concepts.ObjectExtensions.Factory;
  22 import org.opendaylight.yangtools.rfc7952.data.api.NormalizedMetadata;
  23 import org.opendaylight.yangtools.rfc7952.data.api.NormalizedMetadataStreamWriter;
  24 import org.opendaylight.yangtools.rfc7952.data.util.ImmutableNormalizedMetadata;
  25 import org.opendaylight.yangtools.rfc7952.data.util.ImmutableNormalizedMetadata.Builder;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriterExtension;
  29 import org.opendaylight.yangtools.yang.data.api.schema.stream.OpaqueAnydataExtension;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  31
  32 /**
  33  * A {@link NormalizedMetadata}-aware {@link ImmutableMetadataNormalizedNodeStreamWriter}. It advertizes the
  34  * {@link NormalizedMetadataStreamWriter} extension.
  35  */
  36 @Beta
  37 public class ImmutableMetadataNormalizedNodeStreamWriter extends ImmutableNormalizedNodeStreamWriter
  38         implements NormalizedMetadataStreamWriter {
  39     /**
  40      * Snapshot of currently-open data- and metadatastate.
  41      */
  42     public static final class State {
  43         final Builder metaBuilder;
  44         final NormalizedNodeBuilder dataBuilder;
  45
  46         State(final NormalizedNodeBuilder dataBuilder, final Builder metadataBuilder) {
  47             this.dataBuilder = requireNonNull(dataBuilder);
  48             this.metaBuilder = requireNonNull(metadataBuilder);
  49         }
  50
  51         public NormalizedNodeBuilder getDataBuilder() {
  52             return dataBuilder;
  53         }
  54
  55         public Builder getMetaBuilder() {
  56             return metaBuilder;
  57         }
  58     }
  59
  60     private static final Factory<ImmutableMetadataNormalizedNodeStreamWriter, ?, NormalizedNodeStreamWriterExtension>
  61         EXTENSIONS_FACTORY = ObjectExtensions.factory(ImmutableMetadataNormalizedNodeStreamWriter.class,
  62             OpaqueAnydataExtension.class, NormalizedMetadataStreamWriter.class);
  63
  64     private final Deque<Builder> builders = new ArrayDeque<>();
  65     private final NormalizedNodeMetadataResult result;
  66
  67     protected ImmutableMetadataNormalizedNodeStreamWriter(final State state) {
  68         super(state.getDataBuilder());
  69         builders.push(state.getMetaBuilder());
  70         result = null;
  71     }
  72
  73     protected ImmutableMetadataNormalizedNodeStreamWriter(final NormalizedNodeMetadataResult result) {
  74         super(result);
  75         this.result = requireNonNull(result);
  76     }
  77
  78     @Override
  79     public final ClassToInstanceMap<NormalizedNodeStreamWriterExtension> getExtensions() {
  80         return EXTENSIONS_FACTORY.newInstance(this);
  81     }
  82
  83     @Override
  84     public final void metadata(final ImmutableMap<QName, Object> metadata) throws IOException {
  85         final Builder current = builders.peek();
  86         checkState(current != null, "Attempted to emit metadata when no metadata is open");
  87         current.withAnnotations(metadata);
  88     }
  89
  90     /**
  91      * Remove the currently-open builders for data and metadata from the stack.
  92      *
  93      * @return Builder state.
  94      */
  95     protected final @NonNull State popState() {
  96         return new State(popBuilder(), builders.pop());
  97     }
  98
  99     @Override
 100     @SuppressWarnings("rawtypes")
 101     final void enter(final PathArgument identifier, final NormalizedNodeBuilder next) {
 102         super.enter(identifier, next);
 103         builders.push(ImmutableNormalizedMetadata.builder().withIdentifier(identifier));
 104     }
 105
 106     @Override
 107     public final void endNode() {
 108         super.endNode();
 109         final ImmutableNormalizedMetadata metadata = builders.pop().build();
 110         final Builder current = builders.peek();
 111         if (current != null) {
 112             if (!metadata.getAnnotations().isEmpty() || !metadata.getChildren().isEmpty()) {
 113                 current.withChild(metadata);
 114             }
 115         } else {
 116             // All done
 117             result.setResult(metadata);
 118         }
 119     }
 120 }