data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedAnydata.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.api.schema;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.io.IOException;
  12 import org.eclipse.jdt.annotation.NonNullByDefault;
  13 import org.eclipse.jdt.annotation.Nullable;
  14 import org.opendaylight.yangtools.concepts.Immutable;
  15 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  16 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  17 import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
  18
  19 /**
  20  * The contents of an {@code anydata} node in a normalized format. This representation acts as a schema-bound bridge
  21  * between the various (mostly parser-based) representations. Implementations of this interface are usually created
  22  * from an instance of {@link NormalizableAnydata}.
  23  *
  24  * <p>
  25  * Note this interface does not have an equality contract and implementations are expected to default to identity
  26  * equality (or in Valhalla-speak: be plain data).
  27  */
  28 @Beta
  29 @NonNullByDefault
  30 public interface NormalizedAnydata extends Immutable {
  31     /**
  32      * Return the {@link EffectiveStatementInference} which describes the structure returned by {@link #getData()}.
  33      *
  34      * @return An {@link EffectiveStatementInference}
  35      */
  36     EffectiveStatementInference getInference();
  37
  38     /**
  39      * Return the {@link NormalizedNode} representation of this node's data. Information about the corresponding schema
  40      * is available via {@link #getInference()}.
  41      *
  42      * @return A {@link NormalizedNode}
  43      */
  44     NormalizedNode getData();
  45
  46     default void writeTo(final NormalizedNodeStreamWriter writer) throws IOException {
  47         writeTo(writer, true);
  48     }
  49
  50     default void writeTo(final NormalizedNodeStreamWriter writer, final boolean orderKeyLeaves) throws IOException {
  51         NormalizedNodeWriter.forStreamWriter(writer, orderKeyLeaves).write(getData()).flush();
  52     }
  53
  54     static NormalizedAnydata of(final EffectiveStatementInference inference, final NormalizedNode data) {
  55         return new ImmutableNormalizedAnydata(inference, data);
  56     }
  57
  58     static NormalizedAnydata of(final EffectiveStatementInference inference, final NormalizedNode data,
  59             final @Nullable NormalizedMetadata metadata) {
  60         return metadata != null ? MetadataNormalizedAnydata.of(inference, data, metadata) : of(inference, data);
  61     }
  62 }