[Java] Further reduction in copying in JavaGenerator.

Author: mjpt777

sbe-samples/src/main/resources/common-types.xml

@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <types>
- <composite name="messageHeader" description="Message identifiers and length of message root">
+ <composite name="messageHeader" description="Message identifiers and length of message root.">
  <type name="blockLength" primitiveType="uint16"/>
  <type name="templateId" primitiveType="uint16"/>
  <type name="schemaId" primitiveType="uint16"/>
  <type name="version" primitiveType="uint16"/>
  </composite>
- <composite name="groupSizeEncoding" description="Repeating group dimensions">
+ <composite name="groupSizeEncoding" description="Repeating group dimensions.">
  <type name="blockLength" primitiveType="uint16"/>
  <type name="numInGroup" primitiveType="uint16"/>
  </composite>
- <composite name="varStringEncoding">
+ <composite name="varStringEncoding" description="Variable length UTF-8 String.">
  <type name="length" primitiveType="uint32" maxValue="1073741824"/>
  <type name="varData" primitiveType="uint8" length="0" characterEncoding="UTF-8"/>
  </composite>
- <composite name="varAsciiEncoding">
+ <composite name="varAsciiEncoding" description="Variable length ASCII String.">
  <type name="length" primitiveType="uint32" maxValue="1073741824"/>
  <type name="varData" primitiveType="uint8" length="0" characterEncoding="ASCII"/>
  </composite>
- <composite name="varDataEncoding">
+ <composite name="varDataEncoding" description="Variable length binary blob.">
  <type name="length" primitiveType="uint32" maxValue="1073741824"/>
  <type name="varData" primitiveType="uint8" length="0"/>
  </composite>

sbe-samples/src/main/resources/example-extension-schema.xml

@@ -33,9 +33,9 @@
  <ref name="boosterEnabled" type="BooleanType"/>
  <ref name="booster" type="Booster"/>
  </composite>
- <enum name="BooleanType" encodingType="uint8">
- <validValue name="F">0</validValue>
- <validValue name="T">1</validValue>
+ <enum name="BooleanType" encodingType="uint8" description="Boolean Type.">
+ <validValue name="F" description="False value representation.">0</validValue>
+ <validValue name="T" description="True value representation.">1</validValue>
  </enum>
  <enum name="Model" encodingType="char">
  <validValue name="A">A</validValue>

sbe-samples/src/main/resources/example-schema.xml

@@ -33,9 +33,9 @@
  <ref name="boosterEnabled" type="BooleanType"/>
  <ref name="booster" type="Booster"/>
  </composite>
- <enum name="BooleanType" encodingType="uint8">
- <validValue name="F">0</validValue>
- <validValue name="T">1</validValue>
+ <enum name="BooleanType" encodingType="uint8" description="Boolean Type.">
+ <validValue name="F" description="False value representation.">0</validValue>
+ <validValue name="T" description="True value representation.">1</validValue>
  </enum>
  <enum name="Model" encodingType="char">
  <validValue name="A">A</validValue>

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

@@ -681,15 +681,14 @@ private static void generateGroupDecoderProperty(
  indent + " return " + propertyName + ";\n" +
  indent + " }\n\n";
 
+ generateFlyweightPropertyJavadoc(sb, indent + INDENT, token, className);
  sb.append(String.format("\n" +
- "%1$s" +
- indent + " public %2$s %3$s()\n" +
+ indent + " public %1$s %2$s()\n" +
  indent + " {\n" +
- "%4$s" +
- indent + " %3$s.wrap(buffer);\n" +
- indent + " return %3$s;\n" +
+ "%3$s" +
+ indent + " %2$s.wrap(buffer);\n" +
+ indent + " return %2$s;\n" +
  indent + " }\n",
- generateFlyweightPropertyJavadoc(indent + INDENT, token, className),
  className,
  propertyName,
  actingVersionGuard));
@@ -722,14 +721,13 @@ private void generateGroupEncoderProperty(
  formatPropertyName(groupName),
  token.id()));
 
+ generateGroupEncodePropertyJavadoc(sb, indent + INDENT, token, className);
  sb.append(String.format("\n" +
- "%1$s" +
- indent + " public %2$s %3$sCount(final int count)\n" +
+ indent + " public %1$s %2$sCount(final int count)\n" +
  indent + " {\n" +
- indent + " %3$s.wrap(buffer, count);\n" +
- indent + " return %3$s;\n" +
+ indent + " %2$s.wrap(buffer, count);\n" +
+ indent + " return %2$s;\n" +
  indent + " }\n",
- generateGroupEncodePropertyJavadoc(indent + INDENT, token, className),
  className,
  propertyName));
  }
@@ -1347,10 +1345,11 @@ private CharSequence generateChoiceClear(final String bitSetClassName, final Tok
 
  private CharSequence generateChoiceDecoders(final List<Token> tokens)
  {
- return concatTokens(
- tokens,
- Signal.CHOICE,
- (token) ->
+ final StringBuilder sb = new StringBuilder();
+
+ for (final Token token : tokens)
+ {
+ if (token.signal() == Signal.CHOICE)
  {
  final String choiceName = formatPropertyName(token.name());
  final Encoding encoding = token.encoding();
@@ -1359,30 +1358,33 @@ private CharSequence generateChoiceDecoders(final List<Token> tokens)
  final PrimitiveType primitiveType = encoding.primitiveType();
  final String argType = bitsetArgType(primitiveType);
 
- return String.format("\n" +
-  "%1$s" +
- " public boolean %2$s()\n" +
+ generateOptionDecodeJavadoc(sb, INDENT, token);
+ sb.append(String.format("\n" +
+ " public boolean %1$s()\n" +
  " {\n" +
- " return %3$s;\n" +
+ " return %2$s;\n" +
  " }\n\n" +
- " public static boolean %2$s(final %4$s value)\n" +
+ " public static boolean %1$s(final %3$s value)\n" +
  " {\n" +
- " return %5$s;\n" +
+ " return %4$s;\n" +
  " }\n",
- generateOptionDecodeJavadoc(INDENT, token),
  choiceName,
  generateChoiceGet(primitiveType, choiceBitIndex, byteOrderStr),
  argType,
- generateStaticChoiceGet(primitiveType, choiceBitIndex));
- });
+ generateStaticChoiceGet(primitiveType, choiceBitIndex)));
+ }
+ }
+
+ return sb;
  }
 
  private CharSequence generateChoiceEncoders(final String bitSetClassName, final List<Token> tokens)
  {
- return concatTokens(
- tokens,
- Signal.CHOICE,
- (token) ->
+ final StringBuilder sb = new StringBuilder();
+
+ for (final Token token : tokens)
+ {
+ if (token.signal() == Signal.CHOICE)
  {
  final String choiceName = formatPropertyName(token.name());
  final Encoding encoding = token.encoding();
@@ -1391,24 +1393,26 @@ private CharSequence generateChoiceEncoders(final String bitSetClassName, final
  final PrimitiveType primitiveType = encoding.primitiveType();
  final String argType = bitsetArgType(primitiveType);
 
- return String.format("\n" +
-  "%1$s" +
- " public %2$s %3$s(final boolean value)\n" +
+ generateOptionEncodeJavadoc(sb, INDENT, token);
+ sb.append(String.format("\n" +
+ " public %1$s %2$s(final boolean value)\n" +
  " {\n" +
- "%4$s\n" +
+ "%3$s\n" +
  " return this;\n" +
  " }\n\n" +
- " public static %5$s %3$s(final %5$s bits, final boolean value)\n" +
+ " public static %4$s %2$s(final %4$s bits, final boolean value)\n" +
  " {\n" +
- "%6$s" +
+ "%5$s" +
  " }\n",
- generateOptionEncodeJavadoc(INDENT, token),
  bitSetClassName,
  choiceName,
  generateChoicePut(encoding.primitiveType(), choiceBitIndex, byteOrderStr),
  argType,
- generateStaticChoicePut(encoding.primitiveType(), choiceBitIndex));
- });
+ generateStaticChoicePut(encoding.primitiveType(), choiceBitIndex)));
+ }
+ }
+
+ return sb;
  }
 
  private String bitsetArgType(final PrimitiveType primitiveType)
@@ -1638,7 +1642,7 @@ private static CharSequence generateDeclaration(
  .append("public class ").append(className).append(implementsString).append('\n')
  .append("{\n");
 
- return sb.toString();
+ return sb;
  }
 
  private void generatePackageInfo() throws IOException
@@ -1695,7 +1699,7 @@ private static CharSequence generateEnumDeclaration(final String name, final Tok
  generateTypeJavadoc(sb, BASE_INDENT, typeToken);
  sb.append("public enum ").append(name).append("\n{\n");
 
- return sb.toString();
+ return sb;
  }
 
  private CharSequence generatePrimitiveDecoder(
@@ -2843,15 +2847,14 @@ private CharSequence generateBitSetProperty(
  propertyName,
  bitSetName));
 
+ generateFlyweightPropertyJavadoc(sb, indent + INDENT, propertyToken, bitSetName);
  sb.append(String.format("\n" +
- "%s" +
  indent + " public %s %s()\n" +
  indent + " {\n" +
  "%s" +
  indent + " %s.wrap(buffer, offset + %d);\n" +
  indent + " return %s;\n" +
  indent + " }\n",
- generateFlyweightPropertyJavadoc(indent + INDENT, propertyToken, bitSetName),
  bitSetName,
  propertyName,
  generatePropertyNotPresentCondition(inComposite, codecType, propertyToken, null, indent),
@@ -2879,15 +2882,14 @@ private CharSequence generateCompositeProperty(
  propertyName,
  compositeName));
 
+ generateFlyweightPropertyJavadoc(sb, indent + INDENT, propertyToken, compositeName);
  sb.append(String.format("\n" +
- "%s" +
  indent + " public %s %s()\n" +
  indent + " {\n" +
  "%s" +
  indent + " %s.wrap(buffer, offset + %d);\n" +
  indent + " return %s;\n" +
  indent + " }\n",
- generateFlyweightPropertyJavadoc(indent + INDENT, propertyToken, compositeName),
  compositeName,
  propertyName,
  generatePropertyNotPresentCondition(inComposite, codecType, propertyToken, null, indent),

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

@@ -273,97 +273,96 @@ public static void generateTypeJavadoc(
  /**
  * Generate the Javadoc comment header for a bitset choice option decode method.
  *
+ * @param sb to append to.
  * @param indent level for the comment.
  * @param optionToken for the type.
- * @return a string representation of the Javadoc comment.
  */
- public static String generateOptionDecodeJavadoc(final String indent, final Token optionToken)
+ public static void generateOptionDecodeJavadoc(
+ final StringBuilder sb, final String indent, final Token optionToken)
  {
  final String description = optionToken.description();
  if (null == description || description.isEmpty())
  {
- return "";
+ return;
  }
 
- return
- indent + "/**\n" +
- indent + " * " + description + '\n' +
- indent + " *\n" +
- indent + " * @return true if " + optionToken.name() + " is set or false if not\n" +
- indent + " */\n";
+ sb.append(indent).append("/**\n")
+ .append(indent).append(" * ").append(description).append('\n')
+ .append(indent).append(" *\n")
+ .append(indent).append(" * @return true if ").append(optionToken.name()).append(" is set or false if not\n")
+ .append(indent).append(" */\n");
  }
 
  /**
  * Generate the Javadoc comment header for a bitset choice option encode method.
  *
+ * @param sb to append to.
  * @param indent level for the comment.
  * @param optionToken for the type.
- * @return a string representation of the Javadoc comment.
  */
- public static String generateOptionEncodeJavadoc(final String indent, final Token optionToken)
+ public static void generateOptionEncodeJavadoc(
+ final StringBuilder sb, final String indent, final Token optionToken)
  {
  final String description = optionToken.description();
  if (null == description || description.isEmpty())
  {
- return "";
+ return;
  }
 
- return
-  indent + "/**\n" +
- indent + " * " + description + '\n' +
- indent + " *\n" +
- indent + " * @param value true if " + optionToken.name() + " is set or false if not\n" +
- indent + " */\n";
+ final String name = optionToken.name();
+ sb.append(indent).append("/**\n")
+ .append(indent).append(" * ").append(description).append('\n')
+ .append(indent).append(" *\n")
+ .append(indent).append(" * @param value true if ").append(name).append(" is set or false if not.\n")
+ .append(indent).append(" */\n");
  }
 
  /**
  * Generate the Javadoc comment header for flyweight property.
  *
+ * @param sb to append to.
  * @param indent level for the comment.
  * @param propertyToken for the property name.
  * @param typeName for the property type.
- * @return a string representation of the Javadoc comment.
  */
- public static String generateFlyweightPropertyJavadoc(
- final String indent, final Token propertyToken, final String typeName)
+ public static void generateFlyweightPropertyJavadoc(
+ final StringBuilder sb, final String indent, final Token propertyToken, final String typeName)
  {
  final String description = propertyToken.description();
  if (null == description || description.isEmpty())
  {
- return "";
+ return;
  }
 
- return
- indent + "/**\n" +
- indent + " * " + description + '\n' +
- indent + " *\n" +
- indent + " * @return " + typeName + " : " + description + "\n" +
- indent + " */\n";
+ sb.append(indent).append("/**\n")
+ .append(indent).append(" * ").append(description).append('\n')
+ .append(indent).append(" *\n")
+ .append(indent).append(" * @return ").append(typeName).append(" : ").append(description).append("\n")
+ .append(indent).append(" */\n");
  }
 
  /**
  * Generate the Javadoc comment header for group encode property.
  *
+ * @param sb to append to.
  * @param indent level for the comment.
  * @param propertyToken for the property name.
  * @param typeName for the property type.
- * @return a string representation of the Javadoc comment.
  */
- public static String generateGroupEncodePropertyJavadoc(
- final String indent, final Token propertyToken, final String typeName)
+ public static void generateGroupEncodePropertyJavadoc(
+ final StringBuilder sb, final String indent, final Token propertyToken, final String typeName)
  {
  final String description = propertyToken.description();
  if (null == description || description.isEmpty())
  {
- return "";
+ return;
  }
 
- return
- indent + "/**\n" +
- indent + " * " + description + "\n" +
- indent + " *\n" +
- indent + " * @param count of times the group will be encoded\n" +
- indent + " * @return " + typeName + " : encoder for the group\n" +
- indent + " */\n";
+ sb.append(indent).append("/**\n")
+ .append(indent).append(" * ").append(description).append("\n")
+ .append(indent).append(" *\n")
+ .append(indent).append(" * @param count of times the group will be encoded\n")
+ .append(indent).append(" * @return ").append(typeName).append(" : encoder for the group\n")
+ .append(indent).append(" */\n");
  }
 }