Skip to content

Add Objects.requireNonNullElse/ElseGet support to AnnotateNullableParameters #743

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

Merged
merged 6 commits into from
Sep 27, 2025
Merged

Add Objects.requireNonNullElse/ElseGet support to AnnotateNullableParameters #743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
49f6cb1
Add support for Objects.requireNonNull in AnnotateNullableParameters
timtebeek Sep 27, 2025
d91b57e
Replace requireNonNull with requireNonNullElse/ElseGet support
timtebeek Sep 27, 2025
6885955
Merge tests
timtebeek Sep 27, 2025
0bf363c
Only check the first argument, not any fallback
timtebeek Sep 27, 2025
967f4e8
Add Optional.ofNullable support to AnnotateNullableParameters
timtebeek Sep 27, 2025
b9fcc55
Adjust test as suggested
timtebeek Sep 27, 2025
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
17 changes: 17 additions & 0 deletions src/main/java/org/openrewrite/staticanalysis/AnnotateNullableParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ private Map<J.VariableDeclarations, J.Identifier> buildIdentifierMap(List<J.Vari
* <ul>
* <li>Direct null comparisons (param == null, param != null)</li>
* <li>Known null-checking method calls (Objects.isNull, StringUtils.isBlank, etc.)</li>
* <li>Methods that provide default values for null parameters (Objects.requireNonNullElse, Objects.requireNonNullElseGet)</li>
* <li>Methods that handle nullable values (Optional.ofNullable)</li>
* <li>Negated null-checking method calls (!Objects.isNull, !StringUtils.isBlank, etc.)</li>
* </ul>
*/
Expand All @@ -175,6 +177,9 @@ private static class NullCheckVisitor extends JavaIsoVisitor<Set<J.Identifier>>
new MethodMatcher("com.google.common.base.Strings isNullOrEmpty(..)"), // Guava
new MethodMatcher("java.util.Objects isNull(..)"),
new MethodMatcher("java.util.Objects nonNull(..)"),
new MethodMatcher("java.util.Objects requireNonNullElse(..)"), // Provides default for null
new MethodMatcher("java.util.Objects requireNonNullElseGet(..)"), // Provides default for null
new MethodMatcher("java.util.Optional ofNullable(..)"), // Handles nullable values
new MethodMatcher("org.apache.commons.lang3.StringUtils isBlank(..)"),
new MethodMatcher("org.apache.commons.lang3.StringUtils isEmpty(..)"),
new MethodMatcher("org.apache.commons.lang3.StringUtils isNotBlank(..)"),
Expand Down Expand Up @@ -208,6 +213,18 @@ public J.If visitIf(J.If iff, Set<J.Identifier> nullCheckedParams) {
return iff;
}

@Override
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Set<J.Identifier> nullCheckedParams) {
// Handle standalone Objects.requireNonNull calls (not just in if conditions)
if (isKnownNullMethodChecker(method) && method.getArguments().get(0) instanceof J.Identifier) {
J.Identifier firstArgument = (J.Identifier) method.getArguments().get(0);
if (containsIdentifierByName(identifiers, firstArgument)) {
nullCheckedParams.add(firstArgument);
}
}
return super.visitMethodInvocation(method, nullCheckedParams);
}

private void handleCondition(Expression condition, Set<J.Identifier> nullCheckedParams) {
if (condition instanceof J.Binary) {
handleBinary((J.Binary) condition, nullCheckedParams);
Expand Down
110 changes: 110 additions & 0 deletions src/test/java/org/openrewrite/staticanalysis/AnnotateNullableParametersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,116 @@ boolean bar(Object obj) {
@Nested
class KnownNullCheckers {

@Test
void objectsRequireNonNullElse() {
rewriteRun(
//language=java
java(
"""
import java.util.Objects;

class PersonBuilder {
private String name;
private String email;

public PersonBuilder setName(String name) {
this.name = Objects.requireNonNullElse(name, "Unknown");
return this;
}

public PersonBuilder setNameWithFallback(String name, String fallback) {
this.name = Objects.requireNonNullElse(name, fallback);
return this;
}

public PersonBuilder setEmail(String email) {
this.email = Objects.requireNonNullElseGet(email, () -> "default@example.com");
return this;
}
}
""",
"""
import org.jspecify.annotations.Nullable;

import java.util.Objects;

class PersonBuilder {
private String name;
private String email;

public PersonBuilder setName(@Nullable String name) {
this.name = Objects.requireNonNullElse(name, "Unknown");
return this;
}

public PersonBuilder setNameWithFallback(@Nullable String name, String fallback) {
this.name = Objects.requireNonNullElse(name, fallback);
return this;
}

public PersonBuilder setEmail(@Nullable String email) {
this.email = Objects.requireNonNullElseGet(email, () -> "default@example.com");
return this;
}
}
"""
)
);
}

@Test
void optionalOfNullable() {
rewriteRun(
//language=java
java(
"""
import java.util.Optional;

public class PersonService {

public Optional<String> processValue(String value) {
return Optional.ofNullable(value)
.filter(v -> !v.isEmpty())
.map(String::toUpperCase);
}

public Optional<String> wrapValue(String input) {
// Direct usage of parameter in Optional.ofNullable
return Optional.ofNullable(input);
}

public void conditionalWrap(String data) {
Optional.ofNullable(data).ifPresent(d -> System.out.println(d));
}
}
""",
"""
import org.jspecify.annotations.Nullable;

import java.util.Optional;

public class PersonService {

public Optional<String> processValue(@Nullable String value) {
return Optional.ofNullable(value)
.filter(v -> !v.isEmpty())
.map(String::toUpperCase);
}

public Optional<String> wrapValue(@Nullable String input) {
// Direct usage of parameter in Optional.ofNullable
return Optional.ofNullable(input);
}

public void conditionalWrap(@Nullable String data) {
Optional.ofNullable(data).ifPresent(d -> System.out.println(d));
}
}
"""
)
);
}

@CsvSource({
"java.util.Objects, Objects.nonNull",
"org.apache.commons.lang3.StringUtils, StringUtils.isNotBlank",
Expand Down