From eb209847937426168ed7f74cd799872c5ee6606c Mon Sep 17 00:00:00 2001 From: MBWhite Date: Wed, 17 Dec 2025 13:38:21 +0000 Subject: [PATCH 1/5] fix: javadoc for isthmus-cli and examples JavaDoc fixes to ensure the examples and isthmus-cli are clean. Not expecting these to be published, as not APIs to use directly. Signed-off-by: MBWhite --- .../main/java/io/substrait/examples/SchemaHelper.java | 2 +- .../substrait/examples/util/ExpressionStringify.java | 7 ++++++- .../substrait/examples/util/FunctionArgStringify.java | 5 +++++ .../io/substrait/examples/util/ParentStringify.java | 11 +++++++++++ .../substrait/examples/util/SubstraitStringify.java | 1 + .../io/substrait/examples/util/TypeStringify.java | 7 ++++++- isthmus-cli/build.gradle.kts | 10 +++------- .../substrait/isthmus/cli/InitializeAtBuildTime.java | 4 ++++ 8 files changed, 37 insertions(+), 10 deletions(-) create mode 100644 isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java 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..e1c7732c8 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 @@ -19,7 +19,7 @@ private SchemaHelper() {} * * @param createStatements a SQL string containing only CREATE statements * @return a {@link CalciteCatalogReader} generated from the CREATE statements - * @throws SqlParseException + * @throws SqlParseException if the sql 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..878d96a5f 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 @@ -6,8 +6,13 @@ */ public class ParentStringify { + /** Indent character. */ protected String indentChar = " "; + + /** Indents of idnentsize to use. */ protected int indent; + + /** Size of each indent. */ protected int indentSize = 3; /** @@ -50,6 +55,12 @@ StringBuilder getContinuationIndentString() { return sb; } + /** + * Get the outdent to use, decreats indent counter. + * + * @param sb Stribug Builder 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 fbbb57c1c..b5240f819 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..d09e79a3a 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 numver of idents 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 {} From bf371b91e97385e3b76aeafc4de4da96356409f3 Mon Sep 17 00:00:00 2001 From: Matthew B White Date: Thu, 8 Jan 2026 14:31:09 +0000 Subject: [PATCH 2/5] fix: update examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java Co-authored-by: Niels Pardon --- .../src/main/java/io/substrait/examples/SchemaHelper.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 e1c7732c8..a63b7bede 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,7 +17,7 @@ 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 if the sql can not be parsed */ From ae0b5557cb3153149dbbc066d9c13ce11bd93aac Mon Sep 17 00:00:00 2001 From: Matthew B White Date: Thu, 8 Jan 2026 14:31:26 +0000 Subject: [PATCH 3/5] fix: update examples/isthmus-api/src/main/java/io/substrait/examples/SchemaHelper.java Co-authored-by: Niels Pardon --- .../src/main/java/io/substrait/examples/SchemaHelper.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 a63b7bede..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 @@ -19,7 +19,7 @@ private SchemaHelper() {} * * @param createStatements a list of SQL strings containing only CREATE statements * @return a {@link CalciteCatalogReader} generated from the CREATE statements - * @throws SqlParseException if the sql can not be parsed + * @throws SqlParseException if any of the SQL strings can not be parsed */ public static CalciteSchema processCreateStatementsToSchema(final List createStatements) throws SqlParseException { From 4329284db7e797d28c132127d65bb56386c09d8d Mon Sep 17 00:00:00 2001 From: MBWhite Date: Fri, 9 Jan 2026 11:01:04 +0000 Subject: [PATCH 4/5] fix: review comments Signed-off-by: MBWhite --- .../io/substrait/examples/util/ParentStringify.java | 12 ++++++------ .../io/substrait/examples/util/TypeStringify.java | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) 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 878d96a5f..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,15 +1,15 @@ 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 = " "; - /** Indents of idnentsize to use. */ + /** Number of indents to use. */ protected int indent; /** Size of each indent. */ @@ -18,7 +18,7 @@ public class ParentStringify { /** * 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; @@ -56,9 +56,9 @@ StringBuilder getContinuationIndentString() { } /** - * Get the outdent to use, decreats indent counter. + * Get the outdent to use, decrements indent counter. * - * @param sb Stribug Builder with outdent + * @param sb StringBuilder with outdent * @return outdent string */ protected String getOutdent(StringBuilder sb) { 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 d09e79a3a..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 @@ -36,7 +36,7 @@ public class TypeStringify extends ParentStringify /** * Constructor. * - * @param indent numver of idents to use + * @param indent Number of indents to use. */ protected TypeStringify(int indent) { super(indent); From 21f76e433515eb501a53c735a567be26bba66f26 Mon Sep 17 00:00:00 2001 From: MBWhite Date: Mon, 16 Mar 2026 13:50:46 +0000 Subject: [PATCH 5/5] extra file deleted Signed-off-by: MBWhite --- .../java/io/substrait/isthmus/cli/InitializeAtBuildTime.java | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java 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 deleted file mode 100644 index a80396dbf..000000000 --- a/isthmus-cli/src/main/java/io/substrait/isthmus/cli/InitializeAtBuildTime.java +++ /dev/null @@ -1,4 +0,0 @@ -package io.substrait.isthmus.cli; - -/** */ -public class InitializeAtBuildTime {}