Preserve @Nullable parameters in AnnotateRequiredParameters#897
Draft
timtebeek wants to merge 2 commits into
Draft
Preserve @Nullable parameters in AnnotateRequiredParameters#897timtebeek wants to merge 2 commits into
@Nullable parameters in AnnotateRequiredParameters#897timtebeek wants to merge 2 commits into
Conversation
Skip parameters already annotated `@Nullable` so the developer's explicit intent to allow nulls — along with any accompanying custom null check and business exception — is preserved.
Only treat a null-check as redundant when the thrown exception is a JDK type constructed with no arguments. Custom exception types and non-empty message arguments signal intentional business logic and are left intact, along with the surrounding `if` and the parameter (no `@NonNull` added). `Objects.requireNonNull(value, "msg")` continues to be rewritten — that form is idiomatic null-guard boilerplate where message loss is acceptable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
JSpecifyBestPractices(viaAnnotateRequiredParameters) was stripping an explicit@Nullableannotation, swapping in@NonNull, and deleting the user'sif (x == null) throw new IllegalArgumentException("…")business-exception check.@Nullable(matched by simple name to cover all common nullness libraries), so the annotation, the null check, and the custom thrown exception are all preserved.removeNullableAnnotationWhenAddingNonNulltest (which asserted the broken behavior) withpreserveNullableAnnotationAndNullCheck, modeled on the reporter's example.Test plan
./gradlew test --tests AnnotateRequiredParametersTest