Further Support Null Analysis

.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/src/main/java/io/avaje/recordbuilder/internal/BuilderPrism.java

@@ -0,0 +1,45 @@
+package io.avaje.recordbuilder.internal;
+
+import java.util.List;
+
+import javax.lang.model.type.TypeMirror;
+
+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();
+
+  /**
+   * Returns a Boolean representing the value of the {@code boolean public abstract boolean
+   * enforceNullSafety() } member of the Annotation.
+   *
+   * @see io.avaje.recordbuilder.RecordBuilder.Import#enforceNullSafety()
+   */
+  Boolean enforceNullSafety();
+
+  /**
+   * Returns a TypeMirror representing the value of the {@code java.lang.Class<? extends
+   * java.lang.annotation.Annotation> public abstract Class<? extends
+   * java.lang.annotation.Annotation> nullableAnnotation() } member of the Annotation.
+   *
+   * @see io.avaje.recordbuilder.RecordBuilder.Import#nullableAnnotation()
+   */
+  TypeMirror nullableAnnotation();
+
+  /**
+   * Returns a List&lt;TypeMirror&gt; representing the value of the {@code public abstract
+   * Class<?>[] builderInterfaces() } member of the Annotation.
+   *
+   * @see io.avaje.recordbuilder.RecordBuilder.Import#builderInterfaces()
+   */
+  List<TypeMirror> builderInterfaces();
+}

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

@@ -9,16 +9,20 @@
 
 import javax.lang.model.element.RecordComponentElement;
 import javax.lang.model.element.TypeElement;
+import javax.lang.model.type.TypeMirror;
 
 public class ClassBodyBuilder {
 
   private ClassBodyBuilder() {}
 
   static String createClassStart(
-      TypeElement type, String typeParams, boolean isImported, String packageName) {
+      BuilderPrism prism,
+      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;
@@ -39,6 +43,14 @@ static String createClassStart(
 
     final RecordModel rm = new RecordModel(type, isImported, components, utype);
     rm.initialImports();
+    rm.nullableAnnotation(GlobalSettings.nullableAnnotation().orElse(prism.nullableAnnotation().toString()));
+    var implementsStr =
+        prism.builderInterfaces().stream()
+            .map(TypeMirror::toString)
+            .peek(rm::addImport)
+            .map(ProcessorUtils::shortType)
+            .collect(joining(", "))
+            .transform(s -> s.isEmpty() ? s : "implements " + s);
     final String fieldString = rm.fields();
     final var imports = rm.importsFormat();
     final var numberOfComponents = components.size();
@@ -48,11 +60,12 @@ static String createClassStart(
     final String builderFrom =
         builderFrom(components).transform(s -> numberOfComponents > 5 ? "\n        " + s : s);
     final String build =
-        build(components).transform(s -> numberOfComponents > 6 ? "\n        " + s : s);
+        build(components, prism).transform(s -> numberOfComponents > 6 ? "\n        " + s : s);
     return classTemplate(
         packageName,
         imports,
         shortName,
+        implementsStr,
         fieldString,
         constructorParams,
         constructorBody,
@@ -85,7 +98,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, BuilderPrism prism) {
+
+    return components.stream()
+        .map(
+            element -> {
+              final var simpleName = element.getSimpleName();
+              return !Utils.isNullableType(UType.parse(element.asType()).mainType())
+                      && Utils.isNonNullable(element, prism)
+                  ? "requireNonNull(%s, \"%s\")".formatted(simpleName, simpleName)
+                  : simpleName;
+            })
+        .collect(joining(", "));
   }
 }

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

@@ -0,0 +1,212 @@
+package io.avaje.recordbuilder.internal;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.Map;
+import javax.annotation.processing.Generated;
+import javax.lang.model.element.AnnotationMirror;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.VariableElement;
+import javax.lang.model.element.AnnotationValue;
+import javax.lang.model.type.TypeMirror;
+import java.util.HashMap;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.ElementFilter;
+
+/** A Prism representing a {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} annotation. */ 
+@Generated("avaje-prism-generator")
+final class GlobalConfigPrism {
+  /** store prism value of getters */
+  private final Boolean _getters;
+
+  /** store prism value of enforceNullSafety */
+  private final Boolean _enforceNullSafety;
+
+  /** store prism value of nullableAnnotation */
+  private final TypeMirror _nullableAnnotation;
+
+  public static final String PRISM_TYPE = "io.avaje.recordbuilder.RecordBuilder.GlobalConfig";
+
+  /**
+   * An instance of the Values inner class whose
+   * methods return the AnnotationValues used to build this prism. 
+   * Primarily intended to support using Messager.
+   */
+  final Values values;
+
+  /** Returns true if the mirror is an instance of {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} is present on the element, else false.
+   *
+   * @param mirror mirror. 
+   * @return true if prism is present. 
+   */
+  static boolean isInstance(AnnotationMirror mirror) {
+    return getInstance(mirror) != null;
+  }
+
+  /** Returns true if {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} is present on the element, else false.
+   *
+   * @param element element. 
+   * @return true if annotation is present on the element. 
+   */
+  static boolean isPresent(Element element) {
+    return getInstanceOn(element) != null;
+  }
+
+  /** Return a prism representing the {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} annotation present on the given element. 
+   * similar to {@code element.getAnnotation(GlobalConfig.class)} except that 
+   * an instance of this class rather than an instance of {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig}
+   * is returned.
+   *
+   * @param element element. 
+   * @return prism on element or null if no annotation is found. 
+   */
+  static GlobalConfigPrism getInstanceOn(Element element) {
+    final var mirror = getMirror(element);
+    if (mirror == null) return null;
+    return getInstance(mirror);
+  }
+
+  /** Return a Optional representing a nullable {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} annotation on the given element. 
+   * similar to {@code element.getAnnotation(io.avaje.recordbuilder.RecordBuilder.GlobalConfig.class)} except that 
+   * an Optional of this class rather than an instance of {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig}
+   * is returned.
+   *
+   * @param element element. 
+   * @return prism optional for element. 
+   */
+  static Optional<GlobalConfigPrism> getOptionalOn(Element element) {
+    final var mirror = getMirror(element);
+    if (mirror == null) return Optional.empty();
+    return getOptional(mirror);
+  }
+
+  /** Return a prism of the {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} annotation from an annotation mirror. 
+   *
+   * @param mirror mirror. 
+   * @return prism for mirror or null if mirror is an incorrect type. 
+   */
+  static GlobalConfigPrism getInstance(AnnotationMirror mirror) {
+    if (mirror == null || !PRISM_TYPE.equals(mirror.getAnnotationType().toString())) return null;
+
+    return new GlobalConfigPrism(mirror);
+  }
+
+  /** Return an Optional representing a nullable {@link GlobalConfigPrism @GlobalConfigPrism} from an annotation mirror. 
+   * similar to {@code e.getAnnotation(io.avaje.recordbuilder.RecordBuilder.GlobalConfig.class)} except that 
+   * an Optional of this class rather than an instance of {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig}
+   * is returned.
+   *
+   * @param mirror mirror. 
+   * @return prism optional for mirror. 
+   */
+  static Optional<GlobalConfigPrism> getOptional(AnnotationMirror mirror) {
+    if (mirror == null || !PRISM_TYPE.equals(mirror.getAnnotationType().toString())) return Optional.empty();
+
+    return Optional.of(new GlobalConfigPrism(mirror));
+  }
+
+  private GlobalConfigPrism(AnnotationMirror mirror) {
+    for (final ExecutableElement key : mirror.getElementValues().keySet()) {
+      memberValues.put(key.getSimpleName().toString(), mirror.getElementValues().get(key));
+    }
+    for (final ExecutableElement member : ElementFilter.methodsIn(mirror.getAnnotationType().asElement().getEnclosedElements())) {
+      defaults.put(member.getSimpleName().toString(), member.getDefaultValue());
+    }
+    _getters = getValue("getters", Boolean.class);
+    _enforceNullSafety = getValue("enforceNullSafety", Boolean.class);
+    _nullableAnnotation = getValue("nullableAnnotation", TypeMirror.class);
+    this.values = new Values(memberValues);
+    this.mirror = mirror;
+    this.isValid = valid;
+  }
+
+  /** 
+   * Returns a Boolean representing the value of the {@code boolean public abstract boolean getters() } member of the Annotation.
+   * @see io.avaje.recordbuilder.RecordBuilder.GlobalConfig#getters()
+   */ 
+  public Boolean getters() { return _getters; }
+
+  /** 
+   * Returns a Boolean representing the value of the {@code boolean public abstract boolean enforceNullSafety() } member of the Annotation.
+   * @see io.avaje.recordbuilder.RecordBuilder.GlobalConfig#enforceNullSafety()
+   */ 
+  public Boolean enforceNullSafety() { return _enforceNullSafety; }
+
+  /** 
+   * Returns a TypeMirror representing the value of the {@code java.lang.Class<? extends java.lang.annotation.Annotation> public abstract Class<? extends java.lang.annotation.Annotation> nullableAnnotation() } member of the Annotation.
+   * @see io.avaje.recordbuilder.RecordBuilder.GlobalConfig#nullableAnnotation()
+   */ 
+  public TypeMirror nullableAnnotation() { return _nullableAnnotation; }
+
+  /**
+   * 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.
+   * When false is returned, a least one member will either return null, or another
+   * prism that is not valid.
+   */
+   final boolean isValid;
+
+  /**
+   * The underlying AnnotationMirror of the annotation
+   * represented by this Prism. 
+   * Primarily intended to support using Messager.
+   */
+   final AnnotationMirror mirror;
+  /**
+   * A class whose members corespond to those of {@link io.avaje.recordbuilder.RecordBuilder.GlobalConfig @GlobalConfig} 
+   * but which each return the AnnotationValue corresponding to
+   * that member in the model of the annotations. Returns null for
+   * defaulted members. Used for Messager, so default values are not useful.
+   */
+  static final class Values {
+    private final Map<String, AnnotationValue> values;
+
+    private Values(Map<String, AnnotationValue> values) {
+      this.values = values;
+    }    
+    /** 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");}
+    /** Return the AnnotationValue corresponding to the enforceNullSafety() 
+     * member of the annotation, or null when the default value is implied.
+     */
+    AnnotationValue enforceNullSafety(){ return values.get("enforceNullSafety");}
+    /** Return the AnnotationValue corresponding to the nullableAnnotation() 
+     * member of the annotation, or null when the default value is implied.
+     */
+    AnnotationValue nullableAnnotation(){ return values.get("nullableAnnotation");}
+  }
+
+  private final Map<String, AnnotationValue> defaults = new HashMap<String, AnnotationValue>(10);
+  private final Map<String, AnnotationValue> memberValues = new HashMap<String, AnnotationValue>(10);
+  private boolean valid = true;
+
+  private <T> T getValue(String name, Class<T> clazz) {
+    final T result = GlobalConfigPrism.getValue(memberValues, defaults, name, clazz);
+    if (result == null) valid = false;
+    return result;
+  }
+
+  private static AnnotationMirror getMirror(Element target) {
+    for (final var m : target.getAnnotationMirrors()) {
+      final CharSequence mfqn = ((TypeElement) m.getAnnotationType().asElement()).getQualifiedName();
+      if (PRISM_TYPE.contentEquals(mfqn)) return m;
+    }
+    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;
+  }
+
+}