[Java] Style consistency and add JavadocVariable Checkstyle test.

Author: mjpt777

config/checkstyle/checkstyle.xml

@@ -33,6 +33,9 @@
 
  <module name="SuppressWarningsHolder"/>
 
+ <module name="JavadocVariable">
+ <property name="scope" value="public"/>
+ </module>
  <module name="MissingJavadocType"/>
  <module name="MissingJavadocMethod"/>
  <module name="MissingJavadocPackage"/>

config/checkstyle/suppressions.xml

@@ -7,5 +7,6 @@
  <suppress files=".*generated.*" checks="."/>
  <suppress files="[\\/]test[\\/]" checks="MissingJavadoc.*"/>
  <suppress files="[\\/]propertyTest[\\/]" checks="MissingJavadoc.*"/>
+ <suppress files="[\\/]propertyTest[\\/]" checks="JavadocVariable"/>
  <suppress files="[\\/]sbe-benchmarks[\\/]" checks="MissingJavadoc.*"/>
 </suppressions>

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/DtosPropertyTest.java

@@ -64,8 +64,8 @@ public class DtosPropertyTest
  @Property
  void javaDtoEncodeShouldBeTheInverseOfDtoDecode(
  @ForAll("encodedMessage") final SbeArbitraries.EncodedMessage encodedMessage,
- final Footnotes footnotes
- ) throws IOException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException,
+ final Footnotes footnotes)
+   throws IOException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException,
  IllegalAccessException
  {
  final String packageName = encodedMessage.ir().applicableNamespace();
@@ -136,8 +136,8 @@ void javaDtoEncodeShouldBeTheInverseOfDtoDecode(
  @Property
  void csharpDtoEncodeShouldBeTheInverseOfDtoDecode(
  @ForAll("encodedMessage") final SbeArbitraries.EncodedMessage encodedMessage,
- final Footnotes footnotes
- ) throws IOException, InterruptedException
+ final Footnotes footnotes)
+   throws IOException, InterruptedException
  {
  final Path tempDir = Files.createTempDirectory("sbe-csharp-dto-test");
 
@@ -201,17 +201,14 @@ void csharpDtoEncodeShouldBeTheInverseOfDtoDecode(
  @Property(shrinking = ShrinkingMode.OFF)
  void cppDtoEncodeShouldBeTheInverseOfDtoDecode(
  @ForAll("encodedMessage") final SbeArbitraries.EncodedMessage encodedMessage,
- final Footnotes footnotes
- ) throws IOException, InterruptedException
+ final Footnotes footnotes) throws IOException, InterruptedException
  {
  final Path tempDir = Files.createTempDirectory("sbe-cpp-dto-test");
 
  try
  {
  final NamespaceOutputManager outputManager = new NamespaceOutputManager(
- tempDir.toString(),
- "sbe_property_test"
- );
+ tempDir.toString(), "sbe_property_test");
 
  try
  {
@@ -244,7 +241,7 @@ void cppDtoEncodeShouldBeTheInverseOfDtoDecode(
  {
  throw new AssertionError(
  "Input and output files differ\n\n" +
-  "SCHEMA:\n" + encodedMessage.schema());
+ "SCHEMA:\n" + encodedMessage.schema());
  }
  }
  catch (final Throwable throwable)

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/JsonPropertyTest.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties;
 
 import net.jqwik.api.Arbitrary;
@@ -29,9 +28,7 @@
 public class JsonPropertyTest
 {
  @Property
- void shouldGenerateValidJson(
- @ForAll("encodedMessage") final SbeArbitraries.EncodedMessage encodedMessage
- )
+ void shouldGenerateValidJson(@ForAll("encodedMessage") final SbeArbitraries.EncodedMessage encodedMessage)
  {
  final StringBuilder output = new StringBuilder();
  final JsonPrinter printer = new JsonPrinter(encodedMessage.ir());

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/ParserPropertyTest.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties;
 
 import net.jqwik.api.Arbitrary;

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/arbitraries/SbeArbitraries.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties.arbitraries;
 
 import net.jqwik.api.Arbitraries;
@@ -268,9 +267,7 @@ private static Arbitrary<VarDataSchema> varDataSchema()
  (short)0,
  (short)0,
  (short)1,
- (short)2
- )
- );
+ (short)2));
  }
 
  public static Arbitrary<MessageSchema> messageSchema()
@@ -352,8 +349,10 @@ public static CharacterArbitrary chars(final CharGenerationMode mode)
  {
  case UNRESTRICTED:
  return Arbitraries.chars();
+
  case JSON_PRINTER_COMPATIBLE:
  return Arbitraries.chars().alpha();
+
  default:
  throw new IllegalArgumentException("Unsupported mode: " + mode);
  }

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/schema/CompositeTypeSchema.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties.schema;
 
 import java.util.List;
@@ -32,7 +31,6 @@ public List<TypeSchema> fields()
  return fields;
  }
 
- @Override
  public void accept(final TypeSchemaVisitor visitor)
  {
  visitor.onComposite(this);

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/schema/EncodedDataTypeSchema.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties.schema;
 
 import uk.co.real_logic.sbe.PrimitiveType;
@@ -30,8 +29,7 @@ public EncodedDataTypeSchema(
  final PrimitiveType primitiveType,
  final int length,
  final Encoding.Presence presence,
- final boolean isEmbedded
- )
+ final boolean isEmbedded)
  {
  this.primitiveType = primitiveType;
  this.length = length;
@@ -54,16 +52,13 @@ public Encoding.Presence presence()
  return presence;
  }
 
- @Override
  public boolean isEmbedded()
  {
  return isEmbedded;
  }
 
- @Override
  public void accept(final TypeSchemaVisitor visitor)
  {
  visitor.onEncoded(this);
  }
-
 }

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/schema/EnumTypeSchema.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties.schema;
 
 import java.util.List;
@@ -41,7 +40,6 @@ public List<String> validValues()
  return validValues;
  }
 
- @Override
  public void accept(final TypeSchemaVisitor visitor)
  {
  visitor.onEnum(this);

sbe-tool/src/propertyTest/java/uk/co/real_logic/sbe/properties/schema/FieldSchema.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package uk.co.real_logic.sbe.properties.schema;
 
 import uk.co.real_logic.sbe.ir.Encoding;
@@ -27,8 +26,7 @@ public final class FieldSchema
  public FieldSchema(
  final TypeSchema type,
  final Encoding.Presence presence,
- final short sinceVersion
- )
+ final short sinceVersion)
  {
  assert sinceVersion == 0 || presence.equals(Encoding.Presence.OPTIONAL);
  this.type = type;