feat: add NullMarked annotation to generated client, stub, and resource name classes

Author: nnicolee

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceCallableFactoryClassComposer.java

@@ -48,6 +48,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractServiceCallableFactoryClassComposer implements ClassComposer {
   private final TransportContext transportContext;
@@ -93,6 +94,7 @@ public GapicClass generate(GapicContext context, Service service) {
 
   protected List<AnnotationNode> createClassAnnotations(Service service, TypeStore typeStore) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(typeStore.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
     }
@@ -349,7 +351,8 @@ private TypeStore createTypes(Service service) {
             UnaryCallSettings.class,
             UnaryCallable.class,
             Generated.class,
-            UnsupportedOperationException.class);
+            UnsupportedOperationException.class,
+            NullMarked.class);
     return new TypeStore(concreteClazzes);
   }
 }

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceClientClassComposer.java

@@ -103,6 +103,7 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractServiceClientClassComposer implements ClassComposer {
   private static final String CALLABLE_NAME_PATTERN = "%sCallable";
@@ -193,6 +194,7 @@ public GapicClass generate(GapicContext context, Service service) {
 
   private static List<AnnotationNode> createClassAnnotations(Service service, TypeStore typeStore) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(typeStore.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
     }
@@ -1786,6 +1788,7 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
             InterruptedException.class,
             IOException.class,
             MoreExecutors.class,
+            NullMarked.class,
             Objects.class,
             Operation.class,
             OperationFuture.class,

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceSettingsClassComposer.java

@@ -79,6 +79,7 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractServiceSettingsClassComposer implements ClassComposer {
   private static final String BUILDER_CLASS_NAME = "Builder";
@@ -204,6 +205,7 @@ private static List<CommentStatement> createClassHeaderComments(
 
   private static List<AnnotationNode> createClassAnnotations(Service service) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
     }
@@ -847,7 +849,8 @@ private static TypeStore createStaticTypes() {
             StreamingCallSettings.class,
             StubSettings.class,
             TransportChannelProvider.class,
-            UnaryCallSettings.class);
+            UnaryCallSettings.class,
+            NullMarked.class);
     return new TypeStore(concreteClazzes);
   }
 

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubClassComposer.java

@@ -54,6 +54,7 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractServiceStubClassComposer implements ClassComposer {
 
@@ -93,6 +94,7 @@ public GapicClass generate(GapicContext context, Service service) {
 
   private static List<AnnotationNode> createClassAnnotations(Service service, TypeStore typeStore) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(typeStore.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
     }
@@ -270,7 +272,8 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
             OperationCallable.class,
             ServerStreamingCallable.class,
             UnaryCallable.class,
-            UnsupportedOperationException.class);
+            UnsupportedOperationException.class,
+            NullMarked.class);
     TypeStore typeStore = new TypeStore(concreteClazzes);
 
     typeStore.put("com.google.longrunning.stub", "OperationsStub");

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java

@@ -124,6 +124,7 @@
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
 import javax.annotation.Nullable;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractServiceStubSettingsClassComposer implements ClassComposer {
   private static final Statement EMPTY_LINE_STATEMENT = EmptyLineStatement.create();
@@ -411,6 +412,7 @@ protected MethodDefinition createApiClientHeaderProviderBuilderMethod(
 
   private List<AnnotationNode> createClassAnnotations(Service service) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
     }
@@ -2217,7 +2219,8 @@ private static TypeStore createStaticTypes() {
             SuppressWarnings.class,
             TransportChannelProvider.class,
             UnaryCallSettings.class,
-            UnaryCallable.class);
+            UnaryCallable.class,
+            NullMarked.class);
     return new TypeStore(concreteClazzes);
   }
 

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractTransportServiceStubClassComposer.java

@@ -100,6 +100,7 @@
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
 import javax.annotation.Nullable;
+import org.jspecify.annotations.NullMarked;
 
 public abstract class AbstractTransportServiceStubClassComposer implements ClassComposer {
   private static final List<String> AIP_STANDARDS_METHODS =
@@ -152,7 +153,8 @@ private static TypeStore createStaticTypes() {
             TimeUnit.class,
             TypeRegistry.class,
             UnaryCallable.class,
-            UnsupportedOperationException.class);
+            UnsupportedOperationException.class,
+            NullMarked.class);
     return new TypeStore(concreteClazzes);
   }
 
@@ -548,6 +550,7 @@ private VariableExpr getOperationCallableExpr(Method protoMethod, String callabl
 
   protected List<AnnotationNode> createClassAnnotations(Service service) {
     List<AnnotationNode> annotations = new ArrayList<>();
+    annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("NullMarked")));
     if (!PackageChecker.isGaApi(service.pakkage())) {
       annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
     }

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/resourcename/ResourceNameHelperClassComposer.java

@@ -69,6 +69,7 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 public class ResourceNameHelperClassComposer {
   private static final String CLASS_NAME_PATTERN = "%sName";
@@ -152,6 +153,7 @@ public GapicClass generate(ResourceName resourceName, GapicContext context) {
 
   private static List<AnnotationNode> createClassAnnotations() {
     return Arrays.asList(
+        AnnotationNode.withType(FIXED_TYPESTORE.get("NullMarked")),
         AnnotationNode.builder()
             .setType(FIXED_TYPESTORE.get("Generated"))
             .setDescription("by gapic-generator-java")
@@ -1704,7 +1706,8 @@ private static TypeStore createStaticTypes() {
             PathTemplate.class,
             Preconditions.class,
             com.google.api.resourcenames.ResourceName.class,
-            ValidationException.class);
+            ValidationException.class,
+            NullMarked.class);
     return new TypeStore(concreteClazzes);
   }
 

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden

@@ -8,6 +8,7 @@ import com.google.types.testing.stub.NestedMessageServiceStubSettings;
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -95,6 +96,7 @@ import javax.annotation.Generated;
  *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public class NestedMessageServiceClient implements BackgroundResource {
   private final NestedMessageServiceSettings settings;

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden

@@ -25,6 +25,7 @@ import com.google.common.collect.Lists;
 import java.io.IOException;
 import java.util.List;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -76,6 +77,7 @@ import javax.annotation.Generated;
  * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
  * retries.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 @SuppressWarnings("CanonicalDuration")
 public class EchoWithVersionStubSettings extends StubSettings<EchoWithVersionStubSettings> {

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden

@@ -9,6 +9,7 @@ import java.io.IOException;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -98,6 +99,7 @@ import javax.annotation.Generated;
  *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
+@NullMarked
 @BetaApi
 @Generated("by gapic-generator-java")
 public class BookshopClient implements BackgroundResource {