fix: include field 'deprecated' in ir encoding and decoding

aeron-io · Feb 3, 2025 · 174620a · 174620a
1 parent 0da03ae
commit 174620a
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 2 deletions.
diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/Encoding.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/Encoding.java
@@ -48,6 +48,7 @@ public enum Presence
     }
 
     private Presence presence;
+    private final PrimitiveValue deprecated;
     private final PrimitiveType primitiveType;
     private final ByteOrder byteOrder;
     private final PrimitiveValue minValue;
@@ -62,6 +63,7 @@ public enum Presence
     Encoding()
     {
         presence = Presence.REQUIRED;
+        deprecated = null;
         primitiveType = null;
         byteOrder = ByteOrder.LITTLE_ENDIAN;
         minValue = null;
@@ -76,6 +78,7 @@ public enum Presence
 
     Encoding(
         final Presence presence,
+        final PrimitiveValue deprecated,
         final PrimitiveType primitiveType,
         final ByteOrder byteOrder,
         final PrimitiveValue minValue,
@@ -91,6 +94,7 @@ public enum Presence
         Verify.notNull(byteOrder, "byteOrder");
 
         this.primitiveType = primitiveType;
+        this.deprecated = deprecated;
         this.presence = presence;
         this.byteOrder = byteOrder;
         this.minValue = minValue;
@@ -183,6 +187,16 @@ public void presence(final Presence presence)
         this.presence = presence;
     }
 
+    /**
+     * The version at which a field was deprecated.
+     *
+     * @return the version at which a field was deprecated.
+     */
+    public PrimitiveValue deprecated()
+    {
+        return this.deprecated;
+    }
+
     /**
      * The most applicable null value for the encoded type.
      *
@@ -276,6 +290,7 @@ public String toString()
         return
             "Encoding{" +
                 "presence=" + presence +
+                ", deprecated=" + deprecated +
                 ", primitiveType=" + primitiveType +
                 ", byteOrder=" + byteOrder +
                 ", minValue=" + minValue +
@@ -296,6 +311,7 @@ public static class Builder
     {
         private PrimitiveType primitiveType = null;
         private Presence presence = Presence.REQUIRED;
+        private PrimitiveValue deprecated = null;
         private ByteOrder byteOrder = ByteOrder.LITTLE_ENDIAN;
         private PrimitiveValue minValue = null;
         private PrimitiveValue maxValue = null;
@@ -330,6 +346,18 @@ public Builder presence(final Presence presence)
             return this;
         }
 
+        /**
+         * Deprecated for the Encoding.
+         *
+         * @param deprecated for the Encoding.
+         * @return this for a fluent API.
+         */
+        public Builder deprecated(final PrimitiveValue deprecated)
+        {
+            this.deprecated = deprecated;
+            return this;
+        }
+
         /**
          * ByteOrder for the Encoding.
          *
@@ -446,7 +474,9 @@ public Builder semanticType(final String semanticType)
         public Encoding build()
         {
             return new Encoding(
-                presence, primitiveType,
+                presence,
+                deprecated,
+                primitiveType,
                 byteOrder,
                 minValue,
                 maxValue,

diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/IrEncoder.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/IrEncoder.java
@@ -192,7 +192,8 @@ private int encodeToken(final Token token)
             .signal(mapSignal(token.signal()))
             .primitiveType(mapPrimitiveType(type))
             .byteOrder(mapByteOrder(encoding.byteOrder()))
-            .presence(mapPresence(encoding.presence()));
+            .presence(mapPresence(encoding.presence()))
+            .deprecated(token.deprecated());
 
         try
         {