Skip to content

feat(gapic-generator): Add Nullable annotation to generated classes #13558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nnicolee wants to merge 8 commits into
base: main
Choose a base branch
from
+1,364 −1,134
Open

feat(gapic-generator): Add Nullable annotation to generated classes #13558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc13ef7
feat(gapic-generator): Add Nullable annotation to generated classes
nnicolee Jun 25, 2026
56bb725
feat: revert generator pom.xml and temp compiler dump files
nnicolee Jun 25, 2026
17b370c
feat:update ast + glde
nnicolee Jun 25, 2026
22eb3e6
feat:fixed scoping construct errors
nnicolee Jun 25, 2026
6f283eb
feat: added storage tests
nnicolee Jun 26, 2026
dc59d71
feat:added missing @Nullable and updated goldens
nnicolee Jun 26, 2026
783d6b6
feat: fixed linting
nnicolee Jun 26, 2026
96dffb8
feat: updated @Nullable annotations
nnicolee Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -360,7 +361,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class ComplianceClient implements BackgroundResource {
private final ComplianceSettings settings;
@Nullable private final ComplianceSettings settings;
Comment thread
nnicolee marked this conversation as resolved.
private final ComplianceStub stub;

/** Constructs an instance of ComplianceClient with default settings. */
Expand Down Expand Up @@ -398,6 +399,7 @@ protected ComplianceClient(ComplianceStub stub) {
this.stub = stub;
}

@Nullable
Comment thread
nnicolee marked this conversation as resolved.
public final ComplianceSettings getSettings() {
return settings;
}
Expand Down Expand Up @@ -1548,8 +1550,8 @@ public static class ListLocationsPage
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {

private ListLocationsPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable ListLocationsResponse response) {
super(context, response);
}

Expand All @@ -1559,14 +1561,14 @@ private static ListLocationsPage createEmptyPage() {

@Override
protected ListLocationsPage createPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}

@Override
public ApiFuture<ListLocationsPage> createPageAsync(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ApiFuture<ListLocationsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
Expand All @@ -1580,7 +1582,8 @@ public static class ListLocationsFixedSizeCollection
ListLocationsPage,
ListLocationsFixedSizeCollection> {

private ListLocationsFixedSizeCollection(List<ListLocationsPage> pages, int collectionSize) {
private ListLocationsFixedSizeCollection(
@Nullable List<ListLocationsPage> pages, int collectionSize) {

@lqiu96 lqiu96 Jun 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you double check this one? Do we need to add an annotation here for paging?

@nnicolee nnicolee Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Yes, we need to add an annotation here because two places call this function (createCollection and createEmptyCollection (on line 1590-1) which calls the function with null in the first parameter (which is pages). Verified this annotation with Nullaway!

super(pages, collectionSize);
}

Expand All @@ -1590,7 +1593,7 @@ private static ListLocationsFixedSizeCollection createEmptyCollection() {

@Override
protected ListLocationsFixedSizeCollection createCollection(
List<ListLocationsPage> pages, int collectionSize) {
@Nullable List<ListLocationsPage> pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
Expand Down
5 changes: 3 additions & 2 deletions ...showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import java.util.List;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -231,7 +232,7 @@ public static Builder newHttpJsonBuilder() {
}

/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
public static Builder newBuilder(@Nullable ClientContext clientContext) {
return new Builder(clientContext);
}

Expand All @@ -251,7 +252,7 @@ protected Builder() throws IOException {
this(((ClientContext) null));
}

protected Builder(ClientContext clientContext) {
protected Builder(@Nullable ClientContext clientContext) {
super(ComplianceStubSettings.newBuilder(clientContext));
}

Expand Down
52 changes: 29 additions & 23 deletions java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -369,7 +370,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class EchoClient implements BackgroundResource {
private final EchoSettings settings;
private final @Nullable EchoSettings settings;
private final EchoStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
Expand Down Expand Up @@ -415,7 +416,7 @@ protected EchoClient(EchoStub stub) {
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}

public final EchoSettings getSettings() {
public final @Nullable EchoSettings getSettings() {
return settings;
}

Expand Down Expand Up @@ -1564,8 +1565,8 @@ public static class PagedExpandPage
extends AbstractPage<PagedExpandRequest, PagedExpandResponse, EchoResponse, PagedExpandPage> {

private PagedExpandPage(
PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
PagedExpandResponse response) {
@Nullable PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
@Nullable PagedExpandResponse response) {
super(context, response);
}

Expand All @@ -1575,14 +1576,14 @@ private static PagedExpandPage createEmptyPage() {

@Override
protected PagedExpandPage createPage(
PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
PagedExpandResponse response) {
@Nullable PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
@Nullable PagedExpandResponse response) {
return new PagedExpandPage(context, response);
}

@Override
public ApiFuture<PagedExpandPage> createPageAsync(
PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
@Nullable PageContext<PagedExpandRequest, PagedExpandResponse, EchoResponse> context,
ApiFuture<PagedExpandResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
Expand All @@ -1596,7 +1597,8 @@ public static class PagedExpandFixedSizeCollection
PagedExpandPage,
PagedExpandFixedSizeCollection> {

private PagedExpandFixedSizeCollection(List<PagedExpandPage> pages, int collectionSize) {
private PagedExpandFixedSizeCollection(
@Nullable List<PagedExpandPage> pages, int collectionSize) {
super(pages, collectionSize);
}

Expand All @@ -1606,7 +1608,7 @@ private static PagedExpandFixedSizeCollection createEmptyCollection() {

@Override
protected PagedExpandFixedSizeCollection createCollection(
List<PagedExpandPage> pages, int collectionSize) {
@Nullable List<PagedExpandPage> pages, int collectionSize) {
return new PagedExpandFixedSizeCollection(pages, collectionSize);
}
}
Expand Down Expand Up @@ -1647,12 +1649,13 @@ public static class PagedExpandLegacyMappedPage
PagedExpandLegacyMappedPage> {

private PagedExpandLegacyMappedPage(
PageContext<
@Nullable
PageContext<
PagedExpandRequest,
PagedExpandLegacyMappedResponse,
Map.Entry<String, PagedExpandResponseList>>
context,
PagedExpandLegacyMappedResponse response) {
@Nullable PagedExpandLegacyMappedResponse response) {
super(context, response);
}

Expand All @@ -1662,18 +1665,20 @@ private static PagedExpandLegacyMappedPage createEmptyPage() {

@Override
protected PagedExpandLegacyMappedPage createPage(
PageContext<
@Nullable
PageContext<
PagedExpandRequest,
PagedExpandLegacyMappedResponse,
Map.Entry<String, PagedExpandResponseList>>
context,
PagedExpandLegacyMappedResponse response) {
@Nullable PagedExpandLegacyMappedResponse response) {
return new PagedExpandLegacyMappedPage(context, response);
}

@Override
public ApiFuture<PagedExpandLegacyMappedPage> createPageAsync(
PageContext<
@Nullable
PageContext<
PagedExpandRequest,
PagedExpandLegacyMappedResponse,
Map.Entry<String, PagedExpandResponseList>>
Expand All @@ -1692,7 +1697,7 @@ public static class PagedExpandLegacyMappedFixedSizeCollection
PagedExpandLegacyMappedFixedSizeCollection> {

private PagedExpandLegacyMappedFixedSizeCollection(
List<PagedExpandLegacyMappedPage> pages, int collectionSize) {
@Nullable List<PagedExpandLegacyMappedPage> pages, int collectionSize) {
super(pages, collectionSize);
}

Expand All @@ -1702,7 +1707,7 @@ private static PagedExpandLegacyMappedFixedSizeCollection createEmptyCollection(

@Override
protected PagedExpandLegacyMappedFixedSizeCollection createCollection(
List<PagedExpandLegacyMappedPage> pages, int collectionSize) {
@Nullable List<PagedExpandLegacyMappedPage> pages, int collectionSize) {
return new PagedExpandLegacyMappedFixedSizeCollection(pages, collectionSize);
}
}
Expand Down Expand Up @@ -1736,8 +1741,8 @@ public static class ListLocationsPage
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {

private ListLocationsPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable ListLocationsResponse response) {
super(context, response);
}

Expand All @@ -1747,14 +1752,14 @@ private static ListLocationsPage createEmptyPage() {

@Override
protected ListLocationsPage createPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}

@Override
public ApiFuture<ListLocationsPage> createPageAsync(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
@Nullable PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ApiFuture<ListLocationsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
Expand All @@ -1768,7 +1773,8 @@ public static class ListLocationsFixedSizeCollection
ListLocationsPage,
ListLocationsFixedSizeCollection> {

private ListLocationsFixedSizeCollection(List<ListLocationsPage> pages, int collectionSize) {
private ListLocationsFixedSizeCollection(
@Nullable List<ListLocationsPage> pages, int collectionSize) {
super(pages, collectionSize);
}

Expand All @@ -1778,7 +1784,7 @@ private static ListLocationsFixedSizeCollection createEmptyCollection() {

@Override
protected ListLocationsFixedSizeCollection createCollection(
List<ListLocationsPage> pages, int collectionSize) {
@Nullable List<ListLocationsPage> pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
Expand Down
5 changes: 3 additions & 2 deletions java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import java.util.List;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -278,7 +279,7 @@ public static Builder newHttpJsonBuilder() {
}

/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
public static Builder newBuilder(@Nullable ClientContext clientContext) {
return new Builder(clientContext);
}

Expand All @@ -298,7 +299,7 @@ protected Builder() throws IOException {
this(((ClientContext) null));
}

protected Builder(ClientContext clientContext) {
protected Builder(@Nullable ClientContext clientContext) {
super(EchoStubSettings.newBuilder(clientContext));
}

Expand Down
Loading
Loading