Remove Augmentation{Identifier,Node}

[yangtools.git] / codec / yang-data-codec-binfmt / src / main / java / org / opendaylight / yangtools / yang / data / codec / binfmt / NormalizedNodeDataInput.java

diff --git a/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeDataInput.java b/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeDataInput.java
index 19c447166e31cd9ece12deaf8be4d4ee5eb226d3..4543e155f818e829d6cabc684ab240fb0a96a680 100644 (file)
--- a/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeDataInput.java
+++ b/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeDataInput.java
@@ -7,26 +7,24 @@
  */
 package org.opendaylight.yangtools.yang.data.codec.binfmt;
 
-import com.google.common.annotations.Beta;
 import java.io.DataInput;
 import java.io.IOException;
 import java.util.Optional;
 import org.eclipse.jdt.annotation.NonNull;
-import org.opendaylight.yangtools.yang.common.QName.QNameAwareDataInput;
+import org.opendaylight.yangtools.concepts.Either;
+import org.opendaylight.yangtools.yang.common.QNameAwareDataInput;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.ReusableStreamReceiver;
 import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
 
 /**
  * Interface for reading {@link NormalizedNode}s, {@link YangInstanceIdentifier}s, {@link PathArgument}s
- * and {@link SchemaPath}s.
+ * and {@link SchemaNodeIdentifier}s.
  */
-@Beta
 public interface NormalizedNodeDataInput extends QNameAwareDataInput {
     /**
      * Interpret current stream position as a NormalizedNode, stream its events into a NormalizedNodeStreamWriter.
@@ -34,7 +32,7 @@ public interface NormalizedNodeDataInput extends QNameAwareDataInput {
      * @param writer Writer to emit events to
      * @throws IOException if an error occurs
      * @throws IllegalStateException if the dictionary has been detached
-     * @throws NullPointerException if {@code writer} is null
+     * @throws NullPointerException if {@code writer} is {@code null}
      */
     void streamNormalizedNode(NormalizedNodeStreamWriter writer) throws IOException;
 
@@ -56,24 +54,49 @@ public interface NormalizedNodeDataInput extends QNameAwareDataInput {
      * @return Next node from the stream, or null if end of stream has been reached.
      * @throws IOException if an error occurs
      * @throws IllegalStateException if the dictionary has been detached
+     * @throws NullPointerException if {@code receiver} is {@code null}
      */
     default NormalizedNode readNormalizedNode(final ReusableStreamReceiver receiver) throws IOException {
         try {
             streamNormalizedNode(receiver);
-            return receiver.getResult();
+            return receiver.getResult().data();
         } finally {
             receiver.reset();
         }
     }
 
-    YangInstanceIdentifier readYangInstanceIdentifier() throws IOException;
+    /**
+     * Read a {@link YangInstanceIdentifier} from the reader.
+     *
+     * @return A YangInstanceIdentifier
+     * @throws IOException if an error occurs
+     */
+    @NonNull YangInstanceIdentifier readYangInstanceIdentifier() throws IOException;
 
-    PathArgument readPathArgument() throws IOException;
+    /**
+     * Read a {@link PathArgument} from the reader.
+     *
+     * @return A PathArgument
+     * @throws IOException if an error occurs
+     */
+    default @NonNull PathArgument readPathArgument() throws IOException {
+        final var legacy = readLegacyPathArgument();
+        if (legacy.isFirst()) {
+            return legacy.getFirst();
+        }
+        throw new InvalidNormalizedNodeStreamException(legacy.getSecond() + " does not have a representation");
+    }
 
-    @Deprecated(forRemoval = true)
-    SchemaPath readSchemaPath() throws IOException;
+    /**
+     * Read a {@link PathArgument} or a {@link LegacyPathArgument} from the reader.
+     *
+     * @return {@link Either} a {@link PathArgument} or a {@link LegacyPathArgument}
+     * @throws IOException if an error occurs
+     */
+    @Deprecated(since = "11.0.0")
+    @NonNull Either<PathArgument, LegacyPathArgument> readLegacyPathArgument() throws IOException;
 
-    SchemaNodeIdentifier readSchemaNodeIdentifier() throws IOException;
+    @NonNull SchemaNodeIdentifier readSchemaNodeIdentifier() throws IOException;
 
     /**
      * Return the version of the underlying input stream.
@@ -81,7 +104,7 @@ public interface NormalizedNodeDataInput extends QNameAwareDataInput {
      * @return Stream version
      * @throws IOException if the version cannot be ascertained
      */
-    NormalizedNodeStreamVersion getVersion() throws IOException;
+    @NonNull NormalizedNodeStreamVersion getVersion() throws IOException;
 
     default Optional<NormalizedNode> readOptionalNormalizedNode() throws IOException {
         return readBoolean() ? Optional.of(readNormalizedNode()) : Optional.empty();
@@ -95,6 +118,7 @@ public interface NormalizedNodeDataInput extends QNameAwareDataInput {
      * @return a new {@link NormalizedNodeDataInput} instance
      * @throws InvalidNormalizedNodeStreamException if the stream version is not supported
      * @throws IOException if an error occurs reading from the input
+     * @throws NullPointerException if {@code input} is {@code null}
      */
     static @NonNull NormalizedNodeDataInput newDataInput(final @NonNull DataInput input) throws IOException {
         return new VersionedNormalizedNodeDataInput(input).delegate();
@@ -108,7 +132,7 @@ public interface NormalizedNodeDataInput extends QNameAwareDataInput {
      * @return a new {@link NormalizedNodeDataInput} instance
      * @deprecated Use {@link #newDataInput(DataInput)} instead.
      */
-    @Deprecated(forRemoval = true)
+    @Deprecated(since = "5.0.0", forRemoval = true)
     static @NonNull NormalizedNodeDataInput newDataInputWithoutValidation(final @NonNull DataInput input) {
         return new VersionedNormalizedNodeDataInput(input);
     }