diff --git a/examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java b/examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java index d3fe2cae7..4c968658e 100644 --- a/examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java +++ b/examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java @@ -17,9 +17,9 @@ private SchemaHelper() {} * Parses one or more SQL strings containing only CREATE statements into a {@link * CalciteCatalogReader} * - * @param createStatements a SQL string containing only CREATE statements + * @param createStatements a list of SQL strings containing only CREATE statements * @return a {@link CalciteCatalogReader} generated from the CREATE statements - * @throws SqlParseException + * @throws SqlParseException if any of the SQL strings can not be parsed */ public static CalciteSchema processCreateStatementsToSchema(final List createStatements) throws SqlParseException { diff --git a/examples/substrait-spark/src/main/java/io/substrait/examples/util/ExpressionStringify.java b/examples/substrait-spark/src/main/java/io/substrait/examples/util/ExpressionStringify.java index a22756cc9..cb51562c8 100644 --- a/examples/substrait-spark/src/main/java/io/substrait/examples/util/ExpressionStringify.java +++ b/examples/substrait-spark/src/main/java/io/substrait/examples/util/ExpressionStringify.java @@ -50,10 +50,15 @@ import io.substrait.util.EmptyVisitationContext; import java.util.List; -/** ExpressionStringify gives a simple debug text output for Expressions */ +/** ExpressionStringify gives a simple debug text output for Expressions. */ public class ExpressionStringify extends ParentStringify implements ExpressionVisitor { + /** + * Constructor. + * + * @param indent indent size + */ public ExpressionStringify(int indent) { super(indent); } diff --git a/examples/substrait-spark/src/main/java/io/substrait/examples/util/FunctionArgStringify.java b/examples/substrait-spark/src/main/java/io/substrait/examples/util/FunctionArgStringify.java index 372b7e79f..dcd2d8f4b 100644 --- a/examples/substrait-spark/src/main/java/io/substrait/examples/util/FunctionArgStringify.java +++ b/examples/substrait-spark/src/main/java/io/substrait/examples/util/FunctionArgStringify.java @@ -11,6 +11,11 @@ public class FunctionArgStringify extends ParentStringify implements FuncArgVisitor { + /** + * Constructor + * + * @param indent number of indents to use + */ public FunctionArgStringify(int indent) { super(indent); } diff --git a/examples/substrait-spark/src/main/java/io/substrait/examples/util/ParentStringify.java b/examples/substrait-spark/src/main/java/io/substrait/examples/util/ParentStringify.java index 62535bedc..30160f52c 100644 --- a/examples/substrait-spark/src/main/java/io/substrait/examples/util/ParentStringify.java +++ b/examples/substrait-spark/src/main/java/io/substrait/examples/util/ParentStringify.java @@ -1,19 +1,24 @@ package io.substrait.examples.util; /** - * Parent class of all stringifiers Created as it seemed there could be an optimization to share - * formatting fns between the various stringifiers + * Parent class of all string-ifiers Created as it seemed there could be an optimization to share + * formatting fns between the various string-ifiers */ public class ParentStringify { + /** Indent character. */ protected String indentChar = " "; + + /** Number of indents to use. */ protected int indent; + + /** Size of each indent. */ protected int indentSize = 3; /** * Build with a specific indent at the start - note 'an indent' is set by default to be 3 spaces. * - * @param indent number of indentes + * @param indent Number of indents to use. */ public ParentStringify(int indent) { this.indent = indent; @@ -50,6 +55,12 @@ StringBuilder getContinuationIndentString() { return sb; } + /** + * Get the outdent to use, decrements indent counter. + * + * @param sb StringBuilder with outdent + * @return outdent string + */ protected String getOutdent(StringBuilder sb) { indent--; return (sb).toString(); diff --git a/examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java b/examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java index 36a991a6c..a205d8fb4 100644 --- a/examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java +++ b/examples/substrait-spark/src/main/java/io/substrait/examples/util/SubstraitStringify.java @@ -66,6 +66,7 @@ public class SubstraitStringify extends ParentStringify private boolean showRemap = false; + /** Constructor. */ public SubstraitStringify() { super(0); } diff --git a/examples/substrait-spark/src/main/java/io/substrait/examples/util/TypeStringify.java b/examples/substrait-spark/src/main/java/io/substrait/examples/util/TypeStringify.java index 0e13c3e2e..9ee20e24d 100644 --- a/examples/substrait-spark/src/main/java/io/substrait/examples/util/TypeStringify.java +++ b/examples/substrait-spark/src/main/java/io/substrait/examples/util/TypeStringify.java @@ -29,10 +29,15 @@ import io.substrait.type.Type.VarChar; import io.substrait.type.TypeVisitor; -/** TypeStringify produces a simple debug string of Substrait types */ +/** TypeStringify produces a simple debug string of Substrait types. */ public class TypeStringify extends ParentStringify implements TypeVisitor { + /** + * Constructor. + * + * @param indent Number of indents to use. + */ protected TypeStringify(int indent) { super(indent); } diff --git a/isthmus-cli/build.gradle.kts b/isthmus-cli/build.gradle.kts index 890c55efe..724a08fc7 100644 --- a/isthmus-cli/build.gradle.kts +++ b/isthmus-cli/build.gradle.kts @@ -99,12 +99,8 @@ tasks.register("writeIsthmusVersion") { tasks.named("compileJava") { dependsOn("writeIsthmusVersion") } tasks.named("javadoc") { - description = "Generate Javadoc for main source files (excluding generated)." + description = "Generate Javadoc for main source files (excludes generated)." - val generatedSources = layout.buildDirectory.file("generated/sources").get().getAsFile() - exclude { spec -> spec.file.toPath().startsWith(generatedSources.toPath()) } - options { - require(this is CoreJavadocOptions) - addBooleanOption("Xwerror", true) - } + val isthmusVersionClass = layout.buildDirectory.file("generated/sources").get().getAsFile() + exclude { spec -> spec.file.toPath().startsWith(isthmusVersionClass.toPath()) } } diff --git a/isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java b/isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java new file mode 100644 index 000000000..a80396dbf --- /dev/null +++ b/isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java @@ -0,0 +1,4 @@ +package io.substrait.isthmus.cli; + +/** */ +public class InitializeAtBuildTime {}