[checkerframework]

A bit of a shadow feature because the checker framework folks need to do some work on their side.
this update makes lombok generate a few checker framework annotations (if configured to do so)
which let the checker framework add warnings and errors for example if you misuse builders, or ignore
the return values of withers, etc.

3 files changed, 280 insertions, 0 deletions

diff --git a/test/transform/resource/after-ecj/CheckerFrameworkBasic.java b/test/transform/resource/after-ecj/CheckerFrameworkBasic.java
new file mode 100644
index 00000000..03313c6d
--- /dev/null
+++ b/test/transform/resource/after-ecj/CheckerFrameworkBasic.java
@@ -0,0 +1,59 @@
+import lombok.Data;
+import lombok.experimental.Accessors;
+import lombok.experimental.Wither;
+@Data @Accessors(chain = true) class CheckerFrameworkBasic {
+  private final @Wither int x;
+  private final int y;
+  private int z;
+  public @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") CheckerFrameworkBasic withX(final int x) {
+    return ((this.x == x) ? this : new CheckerFrameworkBasic(x, this.y, this.z));
+  }
+  public @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") int getX() {
+    return this.x;
+  }
+  public @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") int getY() {
+    return this.y;
+  }
+  public @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") int getZ() {
+    return this.z;
+  }
+  public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBasic setZ(final int z) {
+    this.z = z;
+    return this;
+  }
+  public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") boolean equals(final java.lang.Object o) {
+    if ((o == this))
+        return true;
+    if ((! (o instanceof CheckerFrameworkBasic)))
+        return false;
+    final CheckerFrameworkBasic other = (CheckerFrameworkBasic) o;
+    if ((! other.canEqual((java.lang.Object) this)))
+        return false;
+    if ((this.getX() != other.getX()))
+        return false;
+    if ((this.getY() != other.getY()))
+        return false;
+    if ((this.getZ() != other.getZ()))
+        return false;
+    return true;
+  }
+  protected @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") boolean canEqual(final java.lang.Object other) {
+    return (other instanceof CheckerFrameworkBasic);
+  }
+  public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") int hashCode() {
+    final int PRIME = 59;
+    int result = 1;
+    result = ((result * PRIME) + this.getX());
+    result = ((result * PRIME) + this.getY());
+    result = ((result * PRIME) + this.getZ());
+    return result;
+  }
+  public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") java.lang.String toString() {
+    return (((((("CheckerFrameworkBasic(x=" + this.getX()) + ", y=") + this.getY()) + ", z=") + this.getZ()) + ")");
+  }
+  public @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") CheckerFrameworkBasic(final int x, final int y) {
+    super();
+    this.x = x;
+    this.y = y;
+  }
+}
diff --git a/test/transform/resource/after-ecj/CheckerFrameworkBuilder.java b/test/transform/resource/after-ecj/CheckerFrameworkBuilder.java
new file mode 100644
index 00000000..2baad9d9
--- /dev/null
+++ b/test/transform/resource/after-ecj/CheckerFrameworkBuilder.java
@@ -0,0 +1,79 @@
+import java.util.List;
+import lombok.Builder;
+import lombok.Singular;
+@Builder class CheckerFrameworkBuilder {
+  public static @java.lang.SuppressWarnings("all") class CheckerFrameworkBuilderBuilder {
+    private @java.lang.SuppressWarnings("all") int x$value;
+    private @java.lang.SuppressWarnings("all") boolean x$set;
+    private @java.lang.SuppressWarnings("all") int y;
+    private @java.lang.SuppressWarnings("all") int z;
+    private @java.lang.SuppressWarnings("all") java.util.ArrayList<String> names;
+    @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder() {
+      super();
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder x(final @org.checkerframework.checker.builder.qual.NotCalledMethods("x") CheckerFrameworkBuilderBuilder this, final int x) {
+      this.x$value = x;
+      x$set = true;
+      return this;
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder y(final @org.checkerframework.checker.builder.qual.NotCalledMethods("y") CheckerFrameworkBuilderBuilder this, final int y) {
+      this.y = y;
+      return this;
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder z(final @org.checkerframework.checker.builder.qual.NotCalledMethods("z") CheckerFrameworkBuilderBuilder this, final int z) {
+      this.z = z;
+      return this;
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder name(final String name) {
+      if ((this.names == null))
+          this.names = new java.util.ArrayList<String>();
+      this.names.add(name);
+      return this;
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder names(final java.util.Collection<? extends String> names) {
+      if ((this.names == null))
+          this.names = new java.util.ArrayList<String>();
+      this.names.addAll(names);
+      return this;
+    }
+    public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder clearNames() {
+      if ((this.names != null))
+          this.names.clear();
+      return this;
+    }
+    public @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") CheckerFrameworkBuilder build(final @org.checkerframework.checker.builder.qual.CalledMethods({"y", "z"}) CheckerFrameworkBuilderBuilder this) {
+      java.util.List<String> names;
+      switch (((this.names == null) ? 0 : this.names.size())) {
+      case 0 :
+          names = java.util.Collections.emptyList();
+          break;
+      case 1 :
+          names = java.util.Collections.singletonList(this.names.get(0));
+          break;
+      default :
+          names = java.util.Collections.unmodifiableList(new java.util.ArrayList<String>(this.names));
+      }
+      return new CheckerFrameworkBuilder((x$set ? x$value : CheckerFrameworkBuilder.$default$x()), y, z, names);
+    }
+    public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") java.lang.String toString() {
+      return (((((((("CheckerFrameworkBuilder.CheckerFrameworkBuilderBuilder(x$value=" + this.x$value) + ", y=") + this.y) + ", z=") + this.z) + ", names=") + this.names) + ")");
+    }
+  }
+  @Builder.Default int x;
+  int y;
+  int z;
+  @Singular List<String> names;
+  private static @java.lang.SuppressWarnings("all") int $default$x() {
+    return 5;
+  }
+  @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") CheckerFrameworkBuilder(final int x, final int y, final int z, final List<String> names) {
+    super();
+    this.x = x;
+    this.y = y;
+    this.z = z;
+    this.names = names;
+  }
+  public static @org.checkerframework.common.aliasing.qual.Unique @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") CheckerFrameworkBuilderBuilder builder() {
+    return new CheckerFrameworkBuilderBuilder();
+  }
+}
\ No newline at end of file
diff --git a/test/transform/resource/after-ecj/CheckerFrameworkSuperBuilder.java b/test/transform/resource/after-ecj/CheckerFrameworkSuperBuilder.java
new file mode 100644
index 00000000..3901bfce
--- /dev/null
+++ b/test/transform/resource/after-ecj/CheckerFrameworkSuperBuilder.java
@@ -0,0 +1,142 @@
+import java.util.List;
+import lombok.Singular;
+class CheckerFrameworkSuperBuilder {
+  public static @lombok.experimental.SuperBuilder class Parent {
+    public static abstract @java.lang.SuppressWarnings("all") class ParentBuilder<C extends Parent, B extends ParentBuilder<C, B>> {
+      private @java.lang.SuppressWarnings("all") int x$value;
+      private @java.lang.SuppressWarnings("all") boolean x$set;
+      private @java.lang.SuppressWarnings("all") int y;
+      private @java.lang.SuppressWarnings("all") int z;
+      private @java.lang.SuppressWarnings("all") java.util.ArrayList<String> names;
+      public ParentBuilder() {
+      }
+      protected abstract @org.checkerframework.checker.builder.qual.ReturnsReceiver @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") B self();
+      public abstract @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") C build(final @org.checkerframework.checker.builder.qual.CalledMethods({"y", "z"}) ParentBuilder this);
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B x(final @org.checkerframework.checker.builder.qual.NotCalledMethods("x") ParentBuilder this, final int x) {
+        this.x$value = x;
+        x$set = true;
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B y(final @org.checkerframework.checker.builder.qual.NotCalledMethods("y") ParentBuilder this, final int y) {
+        this.y = y;
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B z(final @org.checkerframework.checker.builder.qual.NotCalledMethods("z") ParentBuilder this, final int z) {
+        this.z = z;
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B name(final String name) {
+        if ((this.names == null))
+            this.names = new java.util.ArrayList<String>();
+        this.names.add(name);
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B names(final java.util.Collection<? extends String> names) {
+        if ((this.names == null))
+            this.names = new java.util.ArrayList<String>();
+        this.names.addAll(names);
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B clearNames() {
+        if ((this.names != null))
+            this.names.clear();
+        return self();
+      }
+      public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") java.lang.String toString() {
+        return (((((((("CheckerFrameworkSuperBuilder.Parent.ParentBuilder(x$value=" + this.x$value) + ", y=") + this.y) + ", z=") + this.z) + ", names=") + this.names) + ")");
+      }
+    }
+    private static final @java.lang.SuppressWarnings("all") class ParentBuilderImpl extends ParentBuilder<Parent, ParentBuilderImpl> {
+      private ParentBuilderImpl() {
+      }
+      protected @java.lang.Override @org.checkerframework.checker.builder.qual.ReturnsReceiver @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") ParentBuilderImpl self() {
+        return this;
+      }
+      public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") Parent build(final @org.checkerframework.checker.builder.qual.CalledMethods({"y", "z"}) ParentBuilderImpl this) {
+        return new Parent(this);
+      }
+    }
+    @lombok.Builder.Default int x;
+    int y;
+    int z;
+    @Singular List<String> names;
+    private static @java.lang.SuppressWarnings("all") int $default$x() {
+      return 5;
+    }
+    protected @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") Parent(final ParentBuilder<?, ?> b) {
+      super();
+      if (b.x$set)
+          this.x = b.x$value;
+      else
+          this.x = Parent.$default$x();
+      this.y = b.y;
+      this.z = b.z;
+      java.util.List<String> names;
+      switch (((b.names == null) ? 0 : b.names.size())) {
+      case 0 :
+          names = java.util.Collections.emptyList();
+          break;
+      case 1 :
+          names = java.util.Collections.singletonList(b.names.get(0));
+          break;
+      default :
+          names = java.util.Collections.unmodifiableList(new java.util.ArrayList<String>(b.names));
+      }
+      this.names = names;
+    }
+    public static @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") ParentBuilder<?, ?> builder() {
+      return new ParentBuilderImpl();
+    }
+  }
+  public static @lombok.experimental.SuperBuilder class Child extends Parent {
+    public static abstract @java.lang.SuppressWarnings("all") class ChildBuilder<C extends Child, B extends ChildBuilder<C, B>> extends Parent.ParentBuilder<C, B> {
+      private @java.lang.SuppressWarnings("all") int a$value;
+      private @java.lang.SuppressWarnings("all") boolean a$set;
+      private @java.lang.SuppressWarnings("all") int b;
+      public ChildBuilder() {
+      }
+      protected abstract @java.lang.Override @org.checkerframework.checker.builder.qual.ReturnsReceiver @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") B self();
+      protected abstract @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") C build(final @org.checkerframework.checker.builder.qual.CalledMethods("b") ChildBuilder this);
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B a(final @org.checkerframework.checker.builder.qual.NotCalledMethods("a") ChildBuilder this, final int a) {
+        this.a$value = a;
+        a$set = true;
+        return self();
+      }
+      public @org.checkerframework.checker.builder.qual.ReturnsReceiver @java.lang.SuppressWarnings("all") B b(final @org.checkerframework.checker.builder.qual.NotCalledMethods("b") ChildBuilder this, final int b) {
+        this.b = b;
+        return self();
+      }
+      public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") java.lang.String toString() {
+        return (((((("CheckerFrameworkSuperBuilder.Child.ChildBuilder(super=" + super.toString()) + ", a$value=") + this.a$value) + ", b=") + this.b) + ")");
+      }
+    }
+    private static final @java.lang.SuppressWarnings("all") class ChildBuilderImpl extends ChildBuilder<Child, ChildBuilderImpl> {
+      private ChildBuilderImpl() {
+      }
+      protected @java.lang.Override @org.checkerframework.checker.builder.qual.ReturnsReceiver @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") ChildBuilderImpl self() {
+        return this;
+      }
+      public @java.lang.Override @org.checkerframework.dataflow.qual.SideEffectFree @java.lang.SuppressWarnings("all") Child build(final @org.checkerframework.checker.builder.qual.CalledMethods("b") ChildBuilderImpl this) {
+        return new Child(this);
+      }
+    }
+    @lombok.Builder.Default int a;
+    int b;
+    private static @java.lang.SuppressWarnings("all") int $default$a() {
+      return 1;
+    }
+    protected @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") Child(final ChildBuilder<?, ?> b) {
+      super(b);
+      if (b.a$set)
+          this.a = b.a$value;
+      else
+          this.a = Child.$default$a();
+      this.b = b.b;
+    }
+    public static @org.checkerframework.common.aliasing.qual.Unique @java.lang.SuppressWarnings("all") ChildBuilder<?, ?> builder() {
+      return new ChildBuilderImpl();
+    }
+  }
+  CheckerFrameworkSuperBuilder() {
+  }
+}