Clean up public entrypoints

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

diff --git a/yang/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamVersion.java b/yang/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamVersion.java
index e3cba2110feeaea306dda8cc2f53f614a8771707..3bf680b93abc3cda37df16cfb9badd8358501b6a 100644 (file)
--- a/yang/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamVersion.java
+++ b/yang/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamVersion.java
@@ -8,7 +8,11 @@
 package org.opendaylight.yangtools.yang.data.codec.binfmt;
 
 import com.google.common.annotations.Beta;
+import java.io.DataOutput;
+import java.math.BigInteger;
 import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.opendaylight.yangtools.yang.common.Uint64;
+import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
 
 /**
  * Enumeration of all stream versions this implementation supports on both input and output.
@@ -16,8 +20,65 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 @Beta
 @NonNullByDefault
 public enum NormalizedNodeStreamVersion {
-    LITHIUM,
-    NEON_SR2,
-    SODIUM_SR1,
-    MAGNESIUM;
+    /**
+     * Original stream version, as shipped in OpenDaylight Lithium simultaneous release. The caveat here is that this
+     * version has augmented in OpenDaylight Oxygen to retrofit a non-null representation of the empty type.
+     */
+    // FIXME: 5.0.0: consider deprecating this version
+    LITHIUM {
+        @Override
+        public NormalizedNodeDataOutput newDataOutput(DataOutput output) {
+            return new LithiumNormalizedNodeOutputStreamWriter(output);
+        }
+    },
+    /**
+     * Updated stream version, as shipped in OpenDaylight Neon SR2 release. Improves identifier encoding over
+     * {@link #LITHIUM}, so that QName caching is more effective.
+     */
+    NEON_SR2 {
+        @Override
+        public NormalizedNodeDataOutput newDataOutput(DataOutput output) {
+            return new NeonSR2NormalizedNodeOutputStreamWriter(output);
+        }
+    },
+    /**
+     * First shipping in Sodium SR1. Improved stream coding to eliminate redundancies present in {@link #NEON_SR2}.
+     * Supports {code Uint8} et al. as well as {@link BigInteger}.
+     */
+    SODIUM_SR1 {
+        @Override
+        public NormalizedNodeDataOutput newDataOutput(DataOutput output) {
+            return new SodiumSR1DataOutput(output);
+        }
+    },
+    /**
+     * First shipping is Magnesium. Does not support {@link BigInteger} mirroring it being superseded by {@link Uint64}
+     * in {@link ValueNode#getValue()}.
+     */
+    MAGNESIUM {
+        @Override
+        public NormalizedNodeDataOutput newDataOutput(DataOutput output) {
+            return new MagnesiumDataOutput(output);
+        }
+    };
+
+    /**
+     * Return the current runtime version. Guaranteed to not throw {@link UnsupportedOperationException} from
+     * {@link #newDataOutput(DataOutput)}.
+     *
+     * @return Current runtime version.
+     */
+    public static NormalizedNodeStreamVersion current() {
+        return MAGNESIUM;
+    }
+
+    /**
+     * Creates a new {@link NormalizedNodeDataOutput} instance that writes to the given output.
+     *
+     * @param output the DataOutput to write to
+     * @return a new {@link NormalizedNodeDataOutput} instance
+     * @throws NullPointerException if {@code output} is null
+     * @throws UnsupportedOperationException if this version cannot be created in this runtime
+     */
+    public abstract NormalizedNodeDataOutput newDataOutput(DataOutput output);
 }