[v1] Add Lombok Builders to classes; make every field final (#1616)

buildSrc/src/main/kotlin/partiql.versions.kt

@@ -42,6 +42,7 @@ object Versions {
     const val kotlinxCoroutines = "1.8.1"
     const val kotlinxCoroutinesJdk8 = "1.8.1"
     const val ktlint = "0.42.1" // we're on an old version of ktlint. TODO upgrade https://github.com/partiql/partiql-lang-kotlin/issues/1418
+    const val lombok = "1.18.34"
 
     // Testing
     const val assertj = "3.11.0"
@@ -80,6 +81,7 @@ object Deps {
     const val kotlinxCoroutines = "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Versions.kotlinxCoroutines}"
     const val kotlinxCoroutinesJdk8 = "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:${Versions.kotlinxCoroutinesJdk8}"
     const val ktlint = "com.pinterest.ktlint:ktlint-core:${Versions.ktlint}"
+    const val lombok = "org.projectlombok:lombok:${Versions.lombok}"
 
     // Testing
     const val assertj = "org.assertj:assertj-core:${Versions.assertj}"

partiql-ast/build.gradle.kts

@@ -24,6 +24,8 @@ dependencies {
     // TODO REMOVE ME ONCE PartiQLValue IS REMOVED
     // THE AST NEEDS ITS OWN "VALUE" REPRESENTATION
     api(project(":partiql-spi"))
+    compileOnly(Deps.lombok)
+    annotationProcessor(Deps.lombok)
 }
 
 tasks.shadowJar {

partiql-ast/src/main/java/org/partiql/ast/v1/Exclude.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -9,9 +10,10 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class Exclude extends AstNode {
     @NotNull
-    public List<ExcludePath> excludePaths;
+    public final List<ExcludePath> excludePaths;
 
     public Exclude(@NotNull List<ExcludePath> excludePaths) {
         this.excludePaths = excludePaths;

partiql-ast/src/main/java/org/partiql/ast/v1/ExcludePath.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.partiql.ast.v1.expr.ExprVarRef;
 
@@ -10,12 +11,13 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class ExcludePath extends AstNode {
     @NotNull
-    public ExprVarRef root;
+    public final ExprVarRef root;
 
     @NotNull
-    public List<ExcludeStep> excludeSteps;
+    public final List<ExcludeStep> excludeSteps;
 
     public ExcludePath(@NotNull ExprVarRef root, @NotNull List<ExcludeStep> excludeSteps) {
         this.root = root;

partiql-ast/src/main/java/org/partiql/ast/v1/ExcludeStep.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -13,9 +14,10 @@ public abstract class ExcludeStep extends AstNode {
     /**
      * TODO docs, equals, hashcode
      */
+    @Builder(builderClassName = "Builder")
     public static class StructField extends ExcludeStep {
         @NotNull
-        public Identifier symbol;
+        public final Identifier symbol;
 
         public StructField(@NotNull Identifier symbol) {
             this.symbol = symbol;
@@ -38,8 +40,9 @@ public <R, C> R accept(@NotNull AstVisitor<R, C> visitor, C ctx) {
     /**
      * TODO docs, equals, hashcode
      */
+    @Builder(builderClassName = "Builder")
     public static class CollIndex extends ExcludeStep {
-        public int index;
+        public final int index;
 
         public CollIndex(int index) {
             this.index = index;
@@ -60,6 +63,7 @@ public <R, C> R accept(@NotNull AstVisitor<R, C> visitor, C ctx) {
     /**
      * TODO docs, equals, hashcode
      */
+    @Builder(builderClassName = "Builder")
     public static class StructWildcard extends ExcludeStep {
         @NotNull
         @Override
@@ -76,6 +80,7 @@ public <R, C> R accept(@NotNull AstVisitor<R, C> visitor, C ctx) {
     /**
      * TODO docs, equals, hashcode
      */
+    @Builder(builderClassName = "Builder")
     public static class CollWildcard extends ExcludeStep {
         @NotNull
         @Override

partiql-ast/src/main/java/org/partiql/ast/v1/Explain.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.partiql.value.PartiQLValue;
 
@@ -11,13 +12,14 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class Explain extends Statement {
     // TODO get rid of PartiQLValue once https://github.com/partiql/partiql-lang-kotlin/issues/1589 is resolved
     @NotNull
-    public Map<String, PartiQLValue> options;
+    public final Map<String, PartiQLValue> options;
 
     @NotNull
-    public Statement statement;
+    public final Statement statement;
 
     public Explain(@NotNull Map<String, PartiQLValue> options, @NotNull Statement statement) {
         this.options = options;

partiql-ast/src/main/java/org/partiql/ast/v1/From.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -9,9 +10,10 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class From extends AstNode {
     @NotNull
-    public List<FromTableRef> tableRefs;
+    public final List<FromTableRef> tableRefs;
 
     public From(@NotNull List<FromTableRef> tableRefs) {
         this.tableRefs = tableRefs;

partiql-ast/src/main/java/org/partiql/ast/v1/FromExpr.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.partiql.ast.v1.expr.Expr;
@@ -11,18 +12,19 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class FromExpr extends FromTableRef {
     @NotNull
-    public Expr expr;
+    public final Expr expr;
 
     @NotNull
-    public FromType fromType;
+    public final FromType fromType;
 
     @Nullable
-    public Identifier asAlias;
+    public final Identifier asAlias;
 
     @Nullable
-    public Identifier atAlias;
+    public final Identifier atAlias;
 
     public FromExpr(@NotNull Expr expr, @NotNull FromType fromType, @Nullable Identifier asAlias,
                     @Nullable Identifier atAlias) {

partiql-ast/src/main/java/org/partiql/ast/v1/FromJoin.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.partiql.ast.v1.expr.Expr;
@@ -11,18 +12,19 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class FromJoin extends FromTableRef {
     @NotNull
-    public From lhs;
+    public final From lhs;
 
     @NotNull
-    public From rhs;
+    public final From rhs;
 
     @Nullable
-    public JoinType joinType;
+    public final JoinType joinType;
 
     @Nullable
-    public Expr condition;
+    public final Expr condition;
 
     public FromJoin(@NotNull From lhs, @NotNull From rhs, @Nullable JoinType joinType, @Nullable Expr condition) {
         this.lhs = lhs;

partiql-ast/src/main/java/org/partiql/ast/v1/GroupBy.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.partiql.ast.v1.expr.Expr;
@@ -11,15 +12,16 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class GroupBy extends AstNode {
     @NotNull
-    public GroupByStrategy strategy;
+    public final GroupByStrategy strategy;
 
     @NotNull
-    public List<Key> keys;
+    public final List<Key> keys;
 
     @Nullable
-    public Identifier asAlias;
+    public final Identifier asAlias;
 
     public GroupBy(@NotNull GroupByStrategy strategy, @NotNull List<Key> keys, @Nullable Identifier asAlias) {
         this.strategy = strategy;
@@ -45,12 +47,13 @@ public <R, C> R accept(@NotNull AstVisitor<R, C> visitor, C ctx) {
     /**
      * TODO docs, equals, hashcode
      */
+    @lombok.Builder(builderClassName = "Builder")
     public static class Key extends AstNode {
         @NotNull
-        public Expr expr;
+        public final Expr expr;
 
         @Nullable
-        public Identifier asAlias;
+        public final Identifier asAlias;
 
         public Key(@NotNull Expr expr, @Nullable Identifier asAlias) {
         this.expr = expr;

partiql-ast/src/main/java/org/partiql/ast/v1/Identifier.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -8,11 +9,12 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class Identifier extends AstNode {
     @NotNull
-    public String symbol;
+    public final String symbol;
 
-    public boolean isDelimited;
+    public final boolean isDelimited;
 
     public Identifier(@NotNull String symbol, boolean isDelimited) {
         this.symbol = symbol;

partiql-ast/src/main/java/org/partiql/ast/v1/IdentifierChain.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -10,12 +11,13 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class IdentifierChain extends AstNode {
     @NotNull
-    public Identifier root;
+    public final Identifier root;
 
     @Nullable
-    public IdentifierChain next;
+    public final IdentifierChain next;
 
     public IdentifierChain(@NotNull Identifier root, @Nullable IdentifierChain next) {
         this.root = root;

partiql-ast/src/main/java/org/partiql/ast/v1/Let.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.partiql.ast.v1.expr.Expr;
 
@@ -10,9 +11,10 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class Let extends AstNode {
     @NotNull
-    public List<Binding> bindings;
+    public final List<Binding> bindings;
 
     public Let(@NotNull List<Binding> bindings) {
         this.bindings = bindings;
@@ -32,12 +34,13 @@ public <R, C> R accept(@NotNull AstVisitor<R, C> visitor, C ctx) {
     /**
      * TODO docs, equals, hashcode
      */
+    @lombok.Builder(builderClassName = "Builder")
     public static class Binding extends AstNode {
         @NotNull
-        public Expr expr;
+        public final Expr expr;
 
         @NotNull
-        public Identifier asAlias;
+        public final Identifier asAlias;
 
         public Binding(@NotNull Expr expr, @NotNull Identifier asAlias) {
             this.expr = expr;

partiql-ast/src/main/java/org/partiql/ast/v1/OrderBy.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -9,9 +10,10 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class OrderBy extends AstNode {
     @NotNull
-    public List<Sort> sorts;
+    public final List<Sort> sorts;
 
     public OrderBy(@NotNull List<Sort> sorts) {
         this.sorts = sorts;

partiql-ast/src/main/java/org/partiql/ast/v1/Query.java

@@ -1,5 +1,6 @@
 package org.partiql.ast.v1;
 
+import lombok.Builder;
 import org.jetbrains.annotations.NotNull;
 import org.partiql.ast.v1.expr.Expr;
 
@@ -10,9 +11,10 @@
 /**
  * TODO docs, equals, hashcode
  */
+@Builder(builderClassName = "Builder")
 public class Query extends Statement {
     @NotNull
-    public Expr expr;
+    public final Expr expr;
 
     public Query(@NotNull Expr expr) {
         this.expr = expr;