Obsolete Lithium streams 49/102949/4
authorRobert Varga <robert.varga@pantheon.tech>
Fri, 28 Oct 2022 22:33:55 +0000 (00:33 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Mon, 6 Mar 2023 15:40:05 +0000 (16:40 +0100)
We nominally support reading Lithium streams, but do not support writing
them out.

JIRA: YANGTOOLS-1492
Change-Id: Ibb820b5ee19ccb188dd1d0603eefe5133e1ff403
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
13 files changed:
codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/LithiumNormalizedNodeInputStreamReader.java
codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/LithiumNormalizedNodeOutputStreamWriter.java [deleted file]
codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamVersion.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/AidSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/BitsSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/BooleanSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/BytesSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/IntSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/MapEntrySerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NipSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/NormalizedNodeStreamReaderWriterTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/StringSerializationTest.java
codec/yang-data-codec-binfmt/src/test/java/org/opendaylight/yangtools/yang/data/codec/binfmt/YiidSerializationTest.java

index 61f5030a06ef533e994fd5dec2f127dec07f2298..52dbc9d74816bd2e47b56e9e8bdcecf19ad26d9b 100755 (executable)
@@ -23,6 +23,7 @@ final class LithiumNormalizedNodeInputStreamReader extends AbstractLithiumDataIn
     }
 
     @Override
+    @Deprecated(since = "11.0.0", forRemoval = true)
     public NormalizedNodeStreamVersion getVersion() {
         return NormalizedNodeStreamVersion.LITHIUM;
     }
diff --git a/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/LithiumNormalizedNodeOutputStreamWriter.java b/codec/yang-data-codec-binfmt/src/main/java/org/opendaylight/yangtools/yang/data/codec/binfmt/LithiumNormalizedNodeOutputStreamWriter.java
deleted file mode 100644 (file)
index 29b812c..0000000
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.yangtools.yang.data.codec.binfmt;
-
-import java.io.DataOutput;
-import java.io.IOException;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.QNameModule;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
-
-/**
- * NormalizedNodeOutputStreamWriter will be used by distributed datastore to send normalized node in
- * a stream.
- * A stream writer wrapper around this class will write node objects to stream in recursive manner.
- * for example - If you have a ContainerNode which has a two LeafNode as children, then
- * you will first call
- * {@link #startContainerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, int)},
- * then will call
- * {@link #leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier, Object)} twice
- * and then, {@link #endNode()} to end container node.
- *
- * <p>Based on the each node, the node type is also written to the stream, that helps in reconstructing the object,
- * while reading.
- */
-final class LithiumNormalizedNodeOutputStreamWriter extends AbstractLithiumDataOutput {
-    LithiumNormalizedNodeOutputStreamWriter(final DataOutput output) {
-        super(output);
-    }
-
-    @Override
-    short streamVersion() {
-        return TokenTypes.LITHIUM_VERSION;
-    }
-
-    @Override
-    void writeQNameInternal(final QName qname) throws IOException {
-        defaultWriteQName(qname);
-    }
-
-    @Override
-    void writeModule(final QNameModule module) throws IOException {
-        defaultWriteModule(module);
-    }
-
-    @Override
-    void writeAugmentationIdentifier(final AugmentationIdentifier aid) throws IOException {
-        defaultWriteAugmentationIdentifier(aid);
-    }
-}
index f150245e03270d13ede86bee838125050e158915..15e67b3d19aa580f9f5b4ca802a1282aa3c813c1 100644 (file)
@@ -21,19 +21,22 @@ public enum NormalizedNodeStreamVersion {
     /**
      * 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.
+     *
+     * @deprecated This version cannot be written in and always required adaption. This version should not be relied
+     *             upon, as it is subject to removal in a future version.
      */
+    @Deprecated(since = "11.0.0", forRemoval = true)
     LITHIUM {
         /**
          * {@inheritDoc}
-         *
-         * @deprecated This version is a historic one and should not be used in code. It does not support current
-         *             mapping of {@code Uint8} et al. and hence results in a stream which needs to be further adapted
-         *             to current definition of LeafNode.
+         * @implSpec
+         *     This method always throws {@link UnsupportedOperationException}.
+         * @deprecated This version is a historic one and writeout is not supported
          */
         @Override
         @Deprecated(since = "10.0.0", forRemoval = true)
         public NormalizedNodeDataOutput newDataOutput(final DataOutput output) {
-            return new LithiumNormalizedNodeOutputStreamWriter(output);
+            throw new UnsupportedOperationException();
         }
     },
     /**
index ae4f28812331f9c9f9e8cac1e94ad34afa82797f..d11f287f9a5254eee4718fd84694f0144c30daf5 100644 (file)
@@ -22,7 +22,6 @@ public class AidSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    8,  97, 530, 4162, 1_175_362, 2_158_407 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   9, 100, 421, 3145,   913_225,   913_231 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1, 4,  94, 332, 2376,   716_618,   912_975 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,  4,  94, 332, 2376,   716_618,   912_975 });
index 57ef65b8980c8eae172757fe8c757c9733127e47..f8957d8701ed7f04b5da32482e05a7cac3a5be34 100644 (file)
@@ -27,7 +27,6 @@ public class BitsSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    100, 104, 229, 1538, 456_764, 785_890 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   102, 106, 231, 1540, 456_766, 785_882 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1,  96, 100, 226, 1536, 456_764, 654_045 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,   96, 100, 226, 1536, 456_764, 654_045 });
index 37c74088daa815953c4430eee588805f94769e3e..a35b9ed91749266fc1cd46ca956acba1a3a581bb 100644 (file)
@@ -19,7 +19,6 @@ public class BooleanSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    97 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   99 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1, 96 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,  96 });
index 7a8c58eb5306b5c047aad5f026609bd791575c27..4c1bb07087557145d18e29d5874bd0fe6d2af2fa 100644 (file)
@@ -24,7 +24,6 @@ public class BytesSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    100, 101, 228, 484, 66020 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   102, 103, 230, 486, 66022 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1,  96,  97, 225, 482, 66020 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,   96,  97, 225, 482, 66020 });
index f2572fb32cc9ea328f3c5e07fc0c2a867446d5bb..6faed8c34ea3eaf3067228fed6cedf651b602939 100644 (file)
@@ -19,7 +19,6 @@ public class IntSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    97, 97, 98,   98, 100, 100, 100, 104, 104, 104 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   99, 99, 100, 100, 102, 102, 102, 106, 106, 106 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1, 96, 97, 96,   98,  96,  98, 100,  96, 100, 104 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,  96, 97, 96,   98,  96,  98, 100,  96, 100, 104 });
index 430c8a6545c83ee95ea9fd097e7d75008d155ecb..c3e03351a9b7db26e11a0a091a59229de704089e 100644 (file)
@@ -27,7 +27,6 @@ public class MapEntrySerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    100, 139, 178, 10_324 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   102, 127, 152,  6_742 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1,  96, 110, 125,  3_927 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,   96, 110, 125,  3_927 });
index 71b05d6cff12ad328b7b06c8d89f1317ae52cf2e..ef0ed856c5dea62a1913ee1c16954189e7a5dad0 100644 (file)
@@ -27,7 +27,6 @@ public class NipSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,     99, 118, 194, 5203, 1_443_411, 2_693_479 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   101, 116, 176, 4181, 1_180_245, 1_772_383 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1,  95, 107, 156, 3409,   982_867, 1_443_164 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,   95, 107, 156, 3409,   982_867, 1_443_164 });
index 5e56ff25f0562a979da2f307dc552d43374767ab..07794ca5eb518325ee49108fb687183179f852a6 100644 (file)
@@ -77,8 +77,6 @@ public class NormalizedNodeStreamReaderWriterTest {
     @Parameters(name = "{0} {1}")
     public static Iterable<Object[]> data() {
         return List.of(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,    Unsigned.BIG_INTEGER,
-                1_050_286, 9_577_973, 171, 1_553, 103, 237,  98 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   Unsigned.BIG_INTEGER,
                 1_049_950, 5_577_993, 161, 1_163, 105, 235, 100 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1, Unsigned.BIG_INTEGER,
index b6eec56a06bbcbd7e9b97bdaa2f971b00a9cf181..a4a20ab58ec5ef0728aca7447e56d2544bee4fa7 100644 (file)
@@ -24,7 +24,6 @@ public class StringSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,     98,  99, 32867, 33554532 },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,   100, 101, 32869, 33554534 },
             new Object[] { NormalizedNodeStreamVersion.SODIUM_SR1,  96,  99, 32865, 33554532 },
             new Object[] { NormalizedNodeStreamVersion.MAGNESIUM,   96,  99, 32865, 33554532 });
index 9c335ab97cdb15ab600c9433a92d242676f30e17..a1086a60a9aa7507e69877baf38f96d3f9400400 100644 (file)
@@ -26,9 +26,6 @@ public class YiidSerializationTest extends AbstractSerializationTest {
     @Parameters(name = "{0}")
     public static Iterable<Object[]> data() {
         return Arrays.asList(
-            new Object[] { NormalizedNodeStreamVersion.LITHIUM,
-                100, 116, 596, 611, 612, 628, 4196, 4436, 1_052_772, 1_246_036, 2_298_693
-            },
             new Object[] { NormalizedNodeStreamVersion.NEON_SR2,
                 102, 108, 288, 489, 294, 502, 1638, 3414,   394_854,   982_870, 1_377_611
             },