Further Support Null Analysis

.github/dependabot.yml

@@ -1,17 +1,19 @@
 version: 2
 updates:
-- package-ecosystem: maven
-  directory: "/"
-  schedule:
-    interval: "weekly"
-  open-pull-requests-limit: 10
-  groups:
-      dev-deps:
-        dependency-type: "development"
-      prod-deps:
-        dependency-type: "production"
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    groups:
+      dependencies:
+        patterns:
+        - "*"
+    labels:
+      - "dependencies"
+    target-branch: "master"
 
-- package-ecosystem: "github-actions"
+  - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
@@ -21,3 +23,7 @@ updates:
     labels:
       - "dependencies"
     target-branch: "master"
+    groups:
+      dependencies:
+        patterns:
+        - "*"

.github/workflows/jdk-ea-stable.yml

@@ -2,11 +2,11 @@
 name: JDK EA Stable
 
 on:
-  push:
-  pull_request:
+  # push:
+  # pull_request:
   workflow_dispatch:
-  schedule:
-    - cron: '39 1 * * 1,3,5'
+  # schedule:
+  #   - cron: '39 1 * * 1,3,5'
 
 jobs:
   build:

.github/workflows/jdk-ea.yml

@@ -2,10 +2,10 @@
 name: JDK EA
 
 on:
-  pull_request:
+  # pull_request:
   workflow_dispatch:
-  schedule:
-    - cron: '39 6 * * 1,3,5'
+  # schedule:
+  #   - cron: '39 6 * * 1,3,5'
 
 jobs:
   build:

.mvn/jvm.config

@@ -0,0 +1,10 @@
+--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED

README.md

@@ -8,8 +8,7 @@ Uses Annotation processing to generate builders for records.
 ## Distinguishing features
 - By default, Collection/Optional Types will not be null (an empty collection/optional will be provided)
 - We can choose the default value of a record component in the generated builder
-- Copies nullability annotations to the generated setters to aid in static analysis
-
+- Support for generating Checker/NullAway compliant builders for static null analysis.
 ## Usage
 ### 1. Add dependency:
 ```xml
@@ -22,7 +21,7 @@ Uses Annotation processing to generate builders for records.
 </dependency>
 ```
 
-When working with Java modules you need to add the annotation module as a static dependency.
+Add the annotation module as a static dependency when working with Java modules.
 ```java
 module my.module {
   requires static io.avaje.recordbuilder;

avaje-record-builder-core/pom.xml

@@ -25,6 +25,13 @@
       <optional>true</optional>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jspecify</groupId>
+      <artifactId>jspecify</artifactId>
+      <version>1.0.0</version>
+      <optional>true</optional>
+      <scope>provided</scope> 
+    </dependency>
 
 	<dependency>
 	  <groupId>io.avaje</groupId>

avaje-record-builder-core/src/main/java/io/avaje/recordbuilder/internal/BuilderPrism.java

@@ -0,0 +1,16 @@
+package io.avaje.recordbuilder.internal;
+
+public interface BuilderPrism {
+
+  default boolean imported() {
+    return this instanceof ImportPrism;
+  }
+
+  /**
+   * Returns a Boolean representing the value of the {@code boolean public abstract boolean
+   * getters() } member of the Annotation.
+   *
+   * @see io.avaje.recordbuilder.RecordBuilder.Import#getters()
+   */
+  Boolean getters();
+}

avaje-record-builder-core/src/main/java/io/avaje/recordbuilder/internal/ClassBodyBuilder.java

@@ -15,10 +15,12 @@ public class ClassBodyBuilder {
   private ClassBodyBuilder() {}
 
   static String createClassStart(
-      TypeElement type, String typeParams, boolean isImported, String packageName) {
+      TypeElement type,
+      String typeParams,
+      boolean isImported,
+      String packageName) {
 
     final var components = type.getRecordComponents();
-
     final var shortName = type.getSimpleName().toString();
     if (type.getEnclosingElement() instanceof TypeElement) {
       isImported = true;
@@ -85,7 +87,18 @@ private static String builderFrom(List<? extends RecordComponentElement> compone
         .collect(joining(", "));
   }
 
-  private static String build(List<? extends RecordComponentElement> components) {
-    return components.stream().map(RecordComponentElement::getSimpleName).collect(joining(", "));
+  private static String build(
+      List<? extends RecordComponentElement> components) {
+
+    return components.stream()
+        .map(
+            element -> {
+              final var simpleName = element.getSimpleName();
+              return !Utils.isNullableType(UType.parse(element.asType()).mainType())
+                      && Utils.isNonNullable(element)
+                  ? "requireNonNull(%s, \"%s\")".formatted(simpleName, simpleName)
+                  : simpleName;
+            })
+        .collect(joining(", "));
   }
 }

avaje-record-builder-core/src/main/java/io/avaje/recordbuilder/internal/ImportPrism.java

@@ -19,10 +19,13 @@
  * A Prism representing a {@link io.avaje.recordbuilder.RecordBuilder.Import @Import} annotation.
  */
 @Generated("avaje-prism-generator")
-final class ImportPrism {
+final class ImportPrism implements BuilderPrism {
   /** store prism value of value */
   private final List<TypeMirror> _value;
 
+  /** store prism value of getters */
+  private final Boolean _getters;
+
   public static final String PRISM_TYPE = "io.avaje.recordbuilder.RecordBuilder.Import";
 
   /**
@@ -71,7 +74,7 @@ static ImportPrism getInstanceOn(Element element) {
   /**
    * Return a Optional representing a nullable {@link
    * io.avaje.recordbuilder.RecordBuilder.Import @Import} annotation on the given element. similar
-   * to {@link element.getAnnotation(io.avaje.recordbuilder.RecordBuilder.Import.class)} except that
+   * to {@code element.getAnnotation(io.avaje.recordbuilder.RecordBuilder.Import.class)} except that
    * an Optional of this class rather than an instance of {@link
    * io.avaje.recordbuilder.RecordBuilder.Import} is returned.
    *
@@ -99,7 +102,7 @@ static ImportPrism getInstance(AnnotationMirror mirror) {
 
   /**
    * Return an Optional representing a nullable {@link ImportPrism @ImportPrism} from an annotation
-   * mirror. similar to {@link e.getAnnotation(io.avaje.recordbuilder.RecordBuilder.Import.class)}
+   * mirror. similar to {@code e.getAnnotation(io.avaje.recordbuilder.RecordBuilder.Import.class)}
    * except that an Optional of this class rather than an instance of {@link
    * io.avaje.recordbuilder.RecordBuilder.Import @Import} is returned.
    *
@@ -122,21 +125,33 @@ private ImportPrism(AnnotationMirror mirror) {
       defaults.put(member.getSimpleName().toString(), member.getDefaultValue());
     }
     _value = getArrayValues("value", TypeMirror.class);
+    _getters = getValue("getters", Boolean.class);
     this.values = new Values(memberValues);
     this.mirror = mirror;
     this.isValid = valid;
   }
 
   /**
-   * Returns a List&lt;TypeMirror&gt; representing the value of the {@code value()} member of the
-   * Annotation.
+   * Returns a List&lt;TypeMirror&gt; representing the value of the {@code public abstract Class<?
+   * extends java.lang.Record>[] value() } member of the Annotation.
    *
    * @see io.avaje.recordbuilder.RecordBuilder.Import#value()
    */
   public List<TypeMirror> value() {
     return _value;
   }
 
+  /**
+   * Returns a Boolean representing the value of the {@code boolean public abstract boolean
+   * getters() } member of the Annotation.
+   *
+   * @see io.avaje.recordbuilder.RecordBuilder.Import#getters()
+   */
+  @Override
+  public Boolean getters() {
+    return _getters;
+  }
+
   /**
    * Determine whether the underlying AnnotationMirror has no errors. True if the underlying
    * AnnotationMirror has no errors. When true is returned, none of the methods will return null.
@@ -150,6 +165,7 @@ public List<TypeMirror> value() {
    * to support using Messager.
    */
   final AnnotationMirror mirror;
+
   /**
    * A class whose members corespond to those of {@link
    * io.avaje.recordbuilder.RecordBuilder.Import @Import} but which each return the AnnotationValue
@@ -162,19 +178,34 @@ static final class Values {
     private Values(Map<String, AnnotationValue> values) {
       this.values = values;
     }
+
     /**
      * Return the AnnotationValue corresponding to the value() member of the annotation, or null
      * when the default value is implied.
      */
     AnnotationValue value() {
       return values.get("value");
     }
+
+    /**
+     * Return the AnnotationValue corresponding to the getters() member of the annotation, or null
+     * when the default value is implied.
+     */
+    AnnotationValue getters() {
+      return values.get("getters");
+    }
   }
 
   private final Map<String, AnnotationValue> defaults = new HashMap<>(10);
   private final Map<String, AnnotationValue> memberValues = new HashMap<>(10);
   private boolean valid = true;
 
+  private <T> T getValue(String name, Class<T> clazz) {
+    final T result = ImportPrism.getValue(memberValues, defaults, name, clazz);
+    if (result == null) valid = false;
+    return result;
+  }
+
   private <T> List<T> getArrayValues(String name, final Class<T> clazz) {
     final List<T> result = ImportPrism.getArrayValues(memberValues, defaults, name, clazz);
     if (result == null) valid = false;
@@ -190,25 +221,43 @@ private static AnnotationMirror getMirror(Element target) {
     return null;
   }
 
+  private static <T> T getValue(
+      Map<String, AnnotationValue> memberValues,
+      Map<String, AnnotationValue> defaults,
+      String name,
+      Class<T> clazz) {
+    AnnotationValue av = memberValues.get(name);
+    if (av == null) av = defaults.get(name);
+    if (av == null) {
+      return null;
+    }
+    if (clazz.isInstance(av.getValue())) return clazz.cast(av.getValue());
+    return null;
+  }
+
   private static <T> List<T> getArrayValues(
       Map<String, AnnotationValue> memberValues,
       Map<String, AnnotationValue> defaults,
       String name,
       final Class<T> clazz) {
     AnnotationValue av = memberValues.get(name);
     if (av == null) av = defaults.get(name);
-    if ((av == null) || !(av.getValue() instanceof List)) {
+    if (av == null) {
       return List.of();
     }
-    final List<T> result = new ArrayList<>();
-    for (final var v : getValueAsList(av)) {
-      if (clazz.isInstance(v.getValue())) {
-        result.add(clazz.cast(v.getValue()));
-      } else {
-        return List.of();
+    if (av.getValue() instanceof List) {
+      final List<T> result = new ArrayList<>();
+      for (final var v : getValueAsList(av)) {
+        if (clazz.isInstance(v.getValue())) {
+          result.add(clazz.cast(v.getValue()));
+        } else {
+          return List.of();
+        }
       }
+      return result;
+    } else {
+      return List.of();
     }
-    return result;
   }
 
   @SuppressWarnings("unchecked")

avaje-record-builder-core/src/main/java/io/avaje/recordbuilder/internal/InitMap.java

@@ -7,6 +7,15 @@ public class InitMap {
   private static final Map<String, String> defaultsMap = new HashMap<>();
 
   static {
+    put("byte", "0");
+    put("short", "0");
+    put("int", "0");
+    put("long", "0L");
+    put("float", "0.0f");
+    put("double", "0.0d");
+    put("char", "\u0000");
+    put("boolean", "false");
+
     // TODO add the rest of the collections
     final var util = "java.util.";
     final var initDiamond = "new java.util.%s<>()";

avaje-record-builder-core/src/main/java/io/avaje/recordbuilder/internal/ModuleReader.java

@@ -17,7 +17,7 @@ static void read(BufferedReader reader) {
         .lines()
         .forEach(
             line -> {
-              if (line.isBlank()) {
+              if (line.isBlank()|| line.contains("import")) {
                 return;
               }