[Java] Capture sinceVersion and description for types in composites that are not directly used as a field. Remove actingVersion guard condition for encoders and apply parent message actingVersion when required in repeating groups. Issue #418.

Author: mjpt777

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java

@@ -31,12 +31,14 @@
 import java.util.function.Function;
 
 import static uk.co.real_logic.sbe.SbeTool.JAVA_INTERFACE_PACKAGE;
+import static uk.co.real_logic.sbe.generation.java.JavaGenerator.CodecType.DECODER;
+import static uk.co.real_logic.sbe.generation.java.JavaGenerator.CodecType.ENCODER;
 import static uk.co.real_logic.sbe.generation.java.JavaUtil.*;
 import static uk.co.real_logic.sbe.ir.GenerationUtil.*;
 
 public class JavaGenerator implements CodeGenerator
 {
-    public enum CodecType
+    enum CodecType
     {
         DECODER,
         ENCODER
@@ -248,7 +250,7 @@ private void generateDecoder(
             generateAnnotations(indent, className, groups, out, 0, this::decoderName);
             out.append(generateDeclaration(className, implementsString));
             out.append(generateDecoderFlyweightCode(className, msgToken));
-            out.append(generateDecoderFields(false, fields, indent));
+            out.append(generateDecoderFields(fields, indent));
 
             final StringBuilder sb = new StringBuilder();
             generateDecoderGroups(sb, className, groups, indent);
@@ -288,7 +290,7 @@ private void generateDecoderGroups(
 
             final List<Token> fields = new ArrayList<>();
             i = collectFields(tokens, i, fields);
-            sb.append(generateDecoderFields(false, fields, indent + INDENT));
+            sb.append(generateDecoderFields(fields, indent + INDENT));
 
             final List<Token> groups = new ArrayList<>();
             i = collectGroups(tokens, i, groups);
@@ -519,11 +521,10 @@ private void generateGroupDecoderClassDeclaration(
             indent + "    private final %3$s dimensions = new %3$s();\n" +
             indent + "    private %4$s parentMessage;\n" +
             indent + "    private %5$s buffer;\n" +
-            indent + "    private int blockLength;\n" +
-            indent + "    private int actingVersion;\n" +
             indent + "    private int count;\n" +
             indent + "    private int index;\n" +
-            indent + "    private int offset;\n\n",
+            indent + "    private int offset;\n" +
+            indent + "    private int blockLength;\n\n",
             formatClassName(groupName),
             dimensionHeaderSize,
             decoderName(dimensionsClassName),
@@ -590,7 +591,7 @@ private static CharSequence generateGroupDecoderProperty(final String groupName,
 
         final String actingVersionGuard = token.version() == 0 ?
             "" :
-            indent + "        if (actingVersion < " + token.version() + ")\n" +
+            indent + "        if (parentMessage.actingVersion < " + token.version() + ")\n" +
             indent + "        {\n" +
             indent + "            " + propertyName + ".count = 0;\n" +
             indent + "            " + propertyName + ".index = -1;\n" +
@@ -1041,17 +1042,17 @@ private void generateComposite(final List<Token> tokens) throws IOException
 
                     case BEGIN_ENUM:
                         out.append(sb);
-                        out.append(generateEnumDecoder(encodingToken, propertyName, encodingToken, BASE_INDENT));
+                        out.append(generateEnumDecoder(true, encodingToken, propertyName, encodingToken, BASE_INDENT));
                         break;
 
                     case BEGIN_SET:
                         out.append(sb);
-                        out.append(generateBitSetProperty(propertyName, encodingToken, BASE_INDENT, typeName));
+                        out.append(generateBitSetProperty(true, DECODER, propertyName, encodingToken, BASE_INDENT, typeName));
                         break;
 
                     case BEGIN_COMPOSITE:
                         out.append(sb);
-                        out.append(generateCompositeProperty(propertyName, encodingToken, BASE_INDENT, typeName));
+                        out.append(generateCompositeProperty(true, DECODER, propertyName, encodingToken, BASE_INDENT, typeName));
                         i += encodingToken.componentTokenCount();
                         break;
                 }
@@ -1091,12 +1092,12 @@ private void generateComposite(final List<Token> tokens) throws IOException
 
                     case BEGIN_SET:
                         out.append(sb);
-                        out.append(generateBitSetProperty(propertyName, encodingToken, BASE_INDENT, typeName));
+                        out.append(generateBitSetProperty(true, ENCODER, propertyName, encodingToken, BASE_INDENT, typeName));
                         break;
 
                     case BEGIN_COMPOSITE:
                         out.append(sb);
-                        out.append(generateCompositeProperty(propertyName, encodingToken, BASE_INDENT, typeName));
+                        out.append(generateCompositeProperty(true, ENCODER, propertyName, encodingToken, BASE_INDENT, typeName));
                         i += encodingToken.componentTokenCount();
                         break;
                 }
@@ -1558,7 +1559,7 @@ private CharSequence generateFieldNotPresentCondition(
         }
 
         return String.format(
-            indent + "        if (actingVersion < %d)\n" +
+            indent + "        if (parentMessage.actingVersion < %d)\n" +
             indent + "        {\n" +
             indent + "            return %s;\n" +
             indent + "        }\n\n",
@@ -1574,7 +1575,7 @@ private static CharSequence generateArrayFieldNotPresentCondition(final int sinc
         }
 
         return String.format(
-            indent + "        if (actingVersion < %d)\n" +
+            indent + "        if (parentMessage.actingVersion < %d)\n" +
             indent + "        {\n" +
             indent + "            return 0;\n" +
             indent + "        }\n\n",
@@ -1589,22 +1590,23 @@ private static CharSequence generateStringNotPresentCondition(final int sinceVer
         }
 
         return String.format(
-            indent + "        if (actingVersion < %d)\n" +
+            indent + "        if (parentMessage.actingVersion < %d)\n" +
             indent + "        {\n" +
             indent + "            return \"\";\n" +
             indent + "        }\n\n",
             sinceVersion);
     }
 
-    private static CharSequence generateTypeFieldNotPresentCondition(final int sinceVersion, final String indent)
+    private static CharSequence generatePropertyNotPresentCondition(
+        final boolean inComposite, final CodecType codecType, final int sinceVersion, final String indent)
     {
-        if (0 == sinceVersion)
+        if (inComposite || codecType == ENCODER || 0 == sinceVersion)
         {
             return "";
         }
 
         return String.format(
-            indent + "        if (actingVersion < %d)\n" +
+            indent + "        if (parentMessage.actingVersion < %d)\n" +
             indent + "        {\n" +
             indent + "            return null;\n" +
             indent + "        }\n\n",
@@ -1906,9 +1908,7 @@ private static CharSequence generateFixedFlyweightCode(
     }
 
     private static CharSequence generateCompositeFlyweightCode(
-        final String className,
-        final int size,
-        final String bufferImplementation)
+        final String className, final int size, final String bufferImplementation)
     {
         return String.format(
             "    public static final int ENCODED_LENGTH = %2$d;\n" +
@@ -1953,7 +1953,7 @@ private CharSequence generateDecoderFlyweightCode(final String className, final
             className,
             readOnlyBuffer);
 
-        return generateFlyweightCode(CodecType.DECODER, className, token, wrapMethod, readOnlyBuffer);
+        return generateFlyweightCode(DECODER, className, token, wrapMethod, readOnlyBuffer);
     }
 
     private CharSequence generateFlyweightCode(
@@ -2082,19 +2082,19 @@ private CharSequence generateEncoderFields(final String containingClassName, fin
                         break;
 
                     case BEGIN_SET:
-                        sb.append(generateBitSetProperty(propertyName, typeToken, indent, typeName));
+                        sb.append(generateBitSetProperty(false, ENCODER, propertyName, typeToken, indent, typeName));
                         break;
 
                     case BEGIN_COMPOSITE:
-                        sb.append(generateCompositeProperty(propertyName, typeToken, indent, typeName));
+                        sb.append(generateCompositeProperty(false, ENCODER, propertyName, typeToken, indent, typeName));
                         break;
                 }
             });
 
         return sb;
     }
 
-    private CharSequence generateDecoderFields(final boolean inComposite, final List<Token> tokens, final String indent)
+    private CharSequence generateDecoderFields(final List<Token> tokens, final String indent)
     {
         final StringBuilder sb = new StringBuilder();
 
@@ -2114,19 +2114,19 @@ private CharSequence generateDecoderFields(final boolean inComposite, final List
                 switch (typeToken.signal())
                 {
                     case ENCODING:
-                        sb.append(generatePrimitiveDecoder(inComposite, propertyName, typeToken, indent));
+                        sb.append(generatePrimitiveDecoder(false, propertyName, typeToken, indent));
                         break;
 
                     case BEGIN_ENUM:
-                        sb.append(generateEnumDecoder(fieldToken, propertyName, typeToken, indent));
+                        sb.append(generateEnumDecoder(false, fieldToken, propertyName, typeToken, indent));
                         break;
 
                     case BEGIN_SET:
-                        sb.append(generateBitSetProperty(propertyName, typeToken, indent, typeName));
+                        sb.append(generateBitSetProperty(false, DECODER, propertyName, typeToken, indent, typeName));
                         break;
 
                     case BEGIN_COMPOSITE:
-                        sb.append(generateCompositeProperty(propertyName, typeToken, indent, typeName));
+                        sb.append(generateCompositeProperty(false, DECODER, propertyName, typeToken, indent, typeName));
                         break;
                 }
             });
@@ -2228,7 +2228,11 @@ private static void generateFieldMetaAttributeMethod(final StringBuilder sb, fin
     }
 
     private CharSequence generateEnumDecoder(
-        final Token signalToken, final String propertyName, final Token token, final String indent)
+        final boolean inComposite,
+        final Token signalToken,
+        final String propertyName,
+        final Token token,
+        final String indent)
     {
         final String enumName = formatClassName(token.name());
         final Encoding encoding = token.encoding();
@@ -2256,7 +2260,7 @@ private CharSequence generateEnumDecoder(
                 indent + "    }\n\n",
                 enumName,
                 propertyName,
-                generateTypeFieldNotPresentCondition(token.version(), indent),
+                generatePropertyNotPresentCondition(inComposite, DECODER, token.version(), indent),
                 enumName,
                 generateGet(encoding.primitiveType(), "offset + " + token.offset(), byteOrderString(encoding)));
         }
@@ -2288,7 +2292,12 @@ private CharSequence generateEnumEncoder(
     }
 
     private CharSequence generateBitSetProperty(
-        final String propertyName, final Token token, final String indent, final String bitSetName)
+        final boolean inComposite,
+        final CodecType codecType,
+        final String propertyName,
+        final Token token,
+        final String indent,
+        final String bitSetName)
     {
         final StringBuilder sb = new StringBuilder();
 
@@ -2309,7 +2318,7 @@ private CharSequence generateBitSetProperty(
             indent + "    }\n",
             bitSetName,
             propertyName,
-            generateTypeFieldNotPresentCondition(token.version(), indent),
+            generatePropertyNotPresentCondition(inComposite, codecType, token.version(), indent),
             propertyName,
             token.offset(),
             propertyName));
@@ -2318,7 +2327,12 @@ private CharSequence generateBitSetProperty(
     }
 
     private CharSequence generateCompositeProperty(
-        final String propertyName, final Token token, final String indent, final String compositeName)
+        final boolean inComposite,
+        final CodecType codecType,
+        final String propertyName,
+        final Token token,
+        final String indent,
+        final String compositeName)
     {
         final StringBuilder sb = new StringBuilder();
 
@@ -2339,7 +2353,7 @@ private CharSequence generateCompositeProperty(
             indent + "    }\n",
             compositeName,
             propertyName,
-            generateTypeFieldNotPresentCondition(token.version(), indent),
+            generatePropertyNotPresentCondition(inComposite, codecType, token.version(), indent),
             propertyName,
             token.offset(),
             propertyName));
@@ -2648,9 +2662,9 @@ private CharSequence generateDecoderDisplay(
         append(sb, indent, "    builder.append(\"|sbeSchemaId=\");");
         append(sb, indent, "    builder.append(SCHEMA_ID);");
         append(sb, indent, "    builder.append(\"|sbeSchemaVersion=\");");
-        append(sb, indent, "    if (actingVersion != SCHEMA_VERSION)");
+        append(sb, indent, "    if (parentMessage.actingVersion != SCHEMA_VERSION)");
         append(sb, indent, "    {");
-        append(sb, indent, "        builder.append(actingVersion);");
+        append(sb, indent, "        builder.append(parentMessage.actingVersion);");
         append(sb, indent, "        builder.append('/');");
         append(sb, indent, "    }");
         append(sb, indent, "    builder.append(SCHEMA_VERSION);");
@@ -2850,6 +2864,7 @@ private int writeTokenDisplay(
 
     private void appendToString(final StringBuilder sb, final String indent)
     {
+        sb.append('\n');
         append(sb, indent, "public String toString()");
         append(sb, indent, "{");
         append(sb, indent, "    return appendTo(new StringBuilder(100)).toString();");

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/FrameCodecDecoder.java

@@ -493,6 +493,7 @@ public String semanticVersion()
         return value;
     }
 
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();
@@ -507,9 +508,9 @@ public StringBuilder appendTo(final StringBuilder builder)
         builder.append("|sbeSchemaId=");
         builder.append(SCHEMA_ID);
         builder.append("|sbeSchemaVersion=");
-        if (actingVersion != SCHEMA_VERSION)
+        if (parentMessage.actingVersion != SCHEMA_VERSION)
         {
-            builder.append(actingVersion);
+            builder.append(parentMessage.actingVersion);
             builder.append('/');
         }
         builder.append(SCHEMA_VERSION);

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/FrameCodecEncoder.java

@@ -431,6 +431,7 @@ public FrameCodecEncoder semanticVersion(final String value)
         return this;
     }
 
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/TokenCodecDecoder.java

@@ -1339,6 +1339,7 @@ public String description()
         return value;
     }
 
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();
@@ -1353,9 +1354,9 @@ public StringBuilder appendTo(final StringBuilder builder)
         builder.append("|sbeSchemaId=");
         builder.append(SCHEMA_ID);
         builder.append("|sbeSchemaVersion=");
-        if (actingVersion != SCHEMA_VERSION)
+        if (parentMessage.actingVersion != SCHEMA_VERSION)
         {
-            builder.append(actingVersion);
+            builder.append(parentMessage.actingVersion);
             builder.append('/');
         }
         builder.append(SCHEMA_VERSION);

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/TokenCodecEncoder.java

@@ -1161,6 +1161,7 @@ public TokenCodecEncoder description(final String value)
         return this;
     }
 
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/VarDataEncodingDecoder.java

@@ -89,6 +89,7 @@ public static short varDataMaxValue()
     {
         return (short)254;
     }
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();
@@ -97,11 +98,11 @@ public String toString()
     public StringBuilder appendTo(final StringBuilder builder)
     {
         builder.append('(');
-        //Token{signal=ENCODING, name='length', description='null', id=-1, version=0, encodedLength=2, offset=0, componentTokenCount=1, encoding=Encoding{presence=REQUIRED, primitiveType=UINT16, byteOrder=LITTLE_ENDIAN, minValue=null, maxValue=null, nullValue=null, constValue=null, characterEncoding='UTF-8', epoch='unix', timeUnit=nanosecond, semanticType='null'}}
+        //Token{signal=ENCODING, name='length', description='null', id=-1, version=0, encodedLength=2, offset=0, componentTokenCount=1, encoding=Encoding{presence=REQUIRED, primitiveType=UINT16, byteOrder=LITTLE_ENDIAN, minValue=null, maxValue=null, nullValue=null, constValue=null, characterEncoding='UTF-8', epoch='null', timeUnit=null, semanticType='null'}}
         builder.append("length=");
         builder.append(length());
         builder.append('|');
-        //Token{signal=ENCODING, name='varData', description='null', id=-1, version=0, encodedLength=-1, offset=2, componentTokenCount=1, encoding=Encoding{presence=REQUIRED, primitiveType=UINT8, byteOrder=LITTLE_ENDIAN, minValue=null, maxValue=null, nullValue=null, constValue=null, characterEncoding='UTF-8', epoch='unix', timeUnit=nanosecond, semanticType='null'}}
+        //Token{signal=ENCODING, name='varData', description='null', id=-1, version=0, encodedLength=-1, offset=2, componentTokenCount=1, encoding=Encoding{presence=REQUIRED, primitiveType=UINT8, byteOrder=LITTLE_ENDIAN, minValue=null, maxValue=null, nullValue=null, constValue=null, characterEncoding='UTF-8', epoch='null', timeUnit=null, semanticType='null'}}
         builder.append(')');
 
         return builder;

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/VarDataEncodingEncoder.java

@@ -90,6 +90,7 @@ public static short varDataMaxValue()
     {
         return (short)254;
     }
+
     public String toString()
     {
         return appendTo(new StringBuilder(100)).toString();

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/CompositeType.java

@@ -120,9 +120,9 @@ public int encodedLength()
     }
 
     /**
-     * Return list of the Type that compose this composite
+     * Return list of the {@link Type}s that compose this composite
      *
-     * @return {@link List} that holds the types in this composite
+     * @return {@link List} that holds the {@link Type}s in this composite
      */
     public List<Type> getTypeList()
     {