generation of annotated getter w/o optional

Author: wadoon

javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/CoreGenerator.java

@@ -53,14 +53,14 @@ public static void main(String[] args) throws Exception {
         }
         Log.setAdapter(new Log.StandardOutStandardErrorAdapter());
         final Path root = Paths.get(args[0], "..", "javaparser-core", "src", "main", "java");
-        final SourceRoot sourceRoot = new SourceRoot(root, parserConfiguration)
+        final SourceRoot sourceRoot = new SourceRoot(root.normalize(), parserConfiguration)
                 //                .setPrinter(LexicalPreservingPrinter::print)
                 ;
         StaticJavaParser.setConfiguration(parserConfiguration);
 
         final Path generatedJavaCcRoot =
                 Paths.get(args[0], "..", "javaparser-core", "target", "generated-sources", "javacc");
-        final SourceRoot generatedJavaCcSourceRoot = new SourceRoot(generatedJavaCcRoot, parserConfiguration)
+        final SourceRoot generatedJavaCcSourceRoot = new SourceRoot(generatedJavaCcRoot.normalize(), parserConfiguration)
                 //                .setPrinter(LexicalPreservingPrinter::print)
                 ;
 

javaparser-core-generators/src/main/java/com/github/javaparser/generator/core/node/PropertyGenerator.java

@@ -29,6 +29,7 @@
 import static com.github.javaparser.utils.Utils.camelCaseToScreaming;
 
 import com.github.javaparser.ast.CompilationUnit;
+import com.github.javaparser.ast.Modifier;
 import com.github.javaparser.ast.Node;
 import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
 import com.github.javaparser.ast.body.EnumConstantDeclaration;
@@ -42,6 +43,9 @@
 import com.github.javaparser.metamodel.JavaParserMetaModel;
 import com.github.javaparser.metamodel.PropertyMetaModel;
 import com.github.javaparser.utils.SourceRoot;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
 import java.util.*;
 
 public class PropertyGenerator extends NodeGenerator {
@@ -58,6 +62,7 @@ protected void generateNode(
             BaseNodeMetaModel nodeMetaModel, CompilationUnit nodeCu, ClassOrInterfaceDeclaration nodeCoid) {
         for (PropertyMetaModel property : nodeMetaModel.getDeclaredPropertyMetaModels()) {
             generateGetter(nodeMetaModel, nodeCoid, property);
+            generateGetterWithAnnot(nodeMetaModel, nodeCoid, property);
             generateSetter(nodeMetaModel, nodeCoid, property);
         }
         nodeMetaModel.getDerivedPropertyMetaModels().forEach(p -> derivedProperties.put(p.getName(), p));
@@ -147,6 +152,30 @@ private void generateGetter(
         addOrReplaceWhenSameSignature(nodeCoid, getter);
     }
 
+    // special variant that uses JSpecify rather than optional.
+    private void generateGetterWithAnnot(
+            BaseNodeMetaModel nodeMetaModel, ClassOrInterfaceDeclaration nodeCoid, PropertyMetaModel property) {
+        final MethodDeclaration getter = new MethodDeclaration(
+                createModifierList(Modifier.DefaultKeyword.PUBLIC), parseType(property.getTypeNameForSetter()), property.getName());
+        annotateWhenOverridden(nodeMetaModel, getter);
+        final BlockStmt body = getter.getBody().get();
+        body.getStatements().clear();
+        nodeCoid.findCompilationUnit().get().addImport(Objects.class);
+
+        if (property.isOptional()) {
+            // Ensure imports have been included.
+            nodeCoid.findCompilationUnit().get().addImport(Nullable.class);
+            getter.addAnnotation(Nullable.class);
+            body.addStatement(f("return %s;", property.getName()));
+        } else {
+            nodeCoid.findCompilationUnit().get().addImport(NonNull.class);
+            getter.addAnnotation(NonNull.class);
+            body.addStatement(f("return Objects.requireNonNull(%s);", property.getName()));
+        }
+
+        addOrReplaceWhenSameSignature(nodeCoid, getter);
+    }
+
     private void generateObservableProperty(
             EnumDeclaration observablePropertyEnum, PropertyMetaModel property, boolean derived) {
         boolean isAttribute = !Node.class.isAssignableFrom(property.getType());

javaparser-core/pom.xml

@@ -1,9 +1,9 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<parent>
-        <artifactId>jmlparser-parent</artifactId>
-        <groupId>io.github.jmltoolkit</groupId>
-        <version>3.26.2-b6-SNAPSHOT</version>
+		<artifactId>jmlparser-parent</artifactId>
+		<groupId>io.github.jmltoolkit</groupId>
+		<version>3.26.2-b6-SNAPSHOT</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 
@@ -31,6 +31,11 @@
 			<artifactId>annotations</artifactId>
 			<version>24.1.0</version>
 		</dependency>
+		<dependency>
+			<groupId>org.jspecify</groupId>
+			<artifactId>jspecify</artifactId>
+			<version>1.0.0</version>
+		</dependency>
 	</dependencies>
 
 	<properties>

javaparser-core/src/main/java/com/github/javaparser/ast/ArrayCreationLevel.java

@@ -35,6 +35,11 @@
 import java.util.Optional;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
 /**
  * In {@code new int[1][2];} there are two ArrayCreationLevel objects,
  * the first one contains the expression "1",
@@ -188,4 +193,14 @@ public boolean replace(Node node, Node replacementNode) {
         }
         return super.replace(node, replacementNode);
     }
+
+    @NonNull()
+    public NodeList<AnnotationExpr> annotations() {
+        return Objects.requireNonNull(annotations);
+    }
+
+    @Nullable()
+    public Expression dimension() {
+        return dimension;
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/CompilationUnit.java

@@ -60,6 +60,9 @@
 import static com.github.javaparser.utils.CodeGenerationUtils.subtractPaths;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
 /**
  * <p>
  * This class represents the entire compilation unit. Each java file denotes a
@@ -849,4 +852,24 @@ public boolean replace(Node node, Node replacementNode) {
         }
         return super.replace(node, replacementNode);
     }
+
+    @NonNull()
+    public NodeList<ImportDeclaration> imports() {
+        return Objects.requireNonNull(imports);
+    }
+
+    @Nullable()
+    public ModuleDeclaration module() {
+        return module;
+    }
+
+    @Nullable()
+    public PackageDeclaration packageDeclaration() {
+        return packageDeclaration;
+    }
+
+    @NonNull()
+    public NodeList<TypeDeclaration<?>> types() {
+        return Objects.requireNonNull(types);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/ImportDeclaration.java

@@ -32,6 +32,10 @@
 import static com.github.javaparser.StaticJavaParser.parseName;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+
 /**
  * An import declaration.
  * <br>{@code import com.github.javaparser.JavaParser;}
@@ -111,14 +115,16 @@ public Name getName() {
     /**
      * Return if the import ends with "*".
      */
+    @NonNull()
     @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
     public boolean isAsterisk() {
-        return isAsterisk;
+        return Objects.requireNonNull(isAsterisk);
     }
 
+    @NonNull()
     @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
     public boolean isStatic() {
-        return isStatic;
+        return Objects.requireNonNull(isStatic);
     }
 
     @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
@@ -180,9 +186,10 @@ public boolean replace(Node node, Node replacementNode) {
         return super.replace(node, replacementNode);
     }
 
+    @NonNull()
     @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
     public boolean isJmlModel() {
-        return isJmlModel;
+        return Objects.requireNonNull(isJmlModel);
     }
 
     public void setIsJmlModel(boolean b) {
@@ -198,4 +205,9 @@ public ImportDeclaration setJmlModel(final boolean isJmlModel) {
         this.isJmlModel = isJmlModel;
         return this;
     }
+
+    @NonNull()
+    public Name name() {
+        return Objects.requireNonNull(name);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/Modifier.java

@@ -31,6 +31,10 @@
 import static com.github.javaparser.ast.NodeList.toNodeList;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+
 /**
  * A modifier, like private, public, or volatile.
  */
@@ -275,4 +279,9 @@ public Modifier(TokenRange tokenRange) {
         super(tokenRange);
         customInitialization();
     }
+
+    @NonNull()
+    public Keyword keyword() {
+        return Objects.requireNonNull(keyword);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/Node.java

@@ -59,6 +59,7 @@
 import com.github.javaparser.printer.configuration.PrinterConfiguration;
 import com.github.javaparser.resolution.SymbolResolver;
 import com.github.javaparser.utils.LineSeparator;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Base class for all nodes of the abstract syntax tree.
@@ -1271,4 +1272,9 @@ private boolean isPhantom(Node node) {
     private boolean inPhantomNode(Node node, int levels) {
         return node.getParentNode().isPresent() && (isPhantom(node.getParentNode().get()) || inPhantomNode(node.getParentNode().get(), levels - 1));
     }
+
+    @Nullable()
+    public Comment comment() {
+        return comment;
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/PackageDeclaration.java

@@ -33,6 +33,10 @@
 import com.github.javaparser.metamodel.PackageDeclarationMetaModel;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+
 /**
  * A package declaration.
  * <br>{@code package com.github.javaparser.ast;}
@@ -184,4 +188,14 @@ public boolean replace(Node node, Node replacementNode) {
         }
         return super.replace(node, replacementNode);
     }
+
+    @NonNull()
+    public NodeList<AnnotationExpr> annotations() {
+        return Objects.requireNonNull(annotations);
+    }
+
+    @NonNull()
+    public Name name() {
+        return Objects.requireNonNull(name);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/body/AnnotationMemberDeclaration.java

@@ -45,6 +45,11 @@
 import java.util.function.Consumer;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.Nullable;
+import org.jspecify.annotations.NonNull;
+
 /**
  * The "int id();" in {@code @interface X { int id(); }}
  * <p>
@@ -284,4 +289,24 @@ public ResolvedAnnotationMemberDeclaration resolve() {
     public Optional<AnnotationMemberDeclaration> toAnnotationMemberDeclaration() {
         return Optional.of(this);
     }
+
+    @Nullable()
+    public Expression defaultValue() {
+        return defaultValue;
+    }
+
+    @NonNull()
+    public NodeList<Modifier> modifiers() {
+        return Objects.requireNonNull(modifiers);
+    }
+
+    @NonNull()
+    public SimpleName name() {
+        return Objects.requireNonNull(name);
+    }
+
+    @NonNull()
+    public Type type() {
+        return Objects.requireNonNull(type);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/body/BodyDeclaration.java

@@ -39,6 +39,10 @@
 import static com.github.javaparser.utils.CodeGenerationUtils.f;
 import static com.github.javaparser.utils.Utils.assertNotNull;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+
 /**
  * Any declaration that can appear between the { and } of a class, interface, enum, or record.
  *
@@ -583,4 +587,9 @@ public Optional<JmlClassLevelDeclaration> toJmlClassLevelDeclaration() {
     @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
     public void ifJmlClassLevelDeclaration(Consumer<JmlClassLevelDeclaration> action) {
     }
+
+    @NonNull()
+    public NodeList<AnnotationExpr> annotations() {
+        return Objects.requireNonNull(annotations);
+    }
 }

javaparser-core/src/main/java/com/github/javaparser/ast/body/CallableDeclaration.java

@@ -44,6 +44,11 @@
 import com.github.javaparser.metamodel.JavaParserMetaModel;
 import com.github.javaparser.metamodel.OptionalProperty;
 
+import java.util.Objects;
+
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
 /**
  * Represents a declaration which is callable eg. a method or a constructor.
  */
@@ -477,4 +482,39 @@ public boolean isVariableArityMethod() {
     public boolean isFixedArityMethod() {
         return !isVariableArityMethod();
     }
+
+    @NonNull()
+    public NodeList<JmlContract> contracts() {
+        return Objects.requireNonNull(contracts);
+    }
+
+    @NonNull()
+    public NodeList<Modifier> modifiers() {
+        return Objects.requireNonNull(modifiers);
+    }
+
+    @NonNull()
+    public SimpleName name() {
+        return Objects.requireNonNull(name);
+    }
+
+    @NonNull()
+    public NodeList<Parameter> parameters() {
+        return Objects.requireNonNull(parameters);
+    }
+
+    @Nullable()
+    public ReceiverParameter receiverParameter() {
+        return receiverParameter;
+    }
+
+    @NonNull()
+    public NodeList<ReferenceType> thrownExceptions() {
+        return Objects.requireNonNull(thrownExceptions);
+    }
+
+    @NonNull()
+    public NodeList<TypeParameter> typeParameters() {
+        return Objects.requireNonNull(typeParameters);
+    }
 }