Add nullability annotations to IndexSearcher APIs #14132
+48
−7
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.
Annotate public APIs with an internal definition of
@Nullable
where appropriate.This proposal is a follow up from the discussion here. This change adds an internal copy of JSpecify's
@Nullable
to lucene-util and uses Intellij's "infer nullability" feature to automatically apply the annotation toIndexSearcher
and its dependencies. If this looks good, there will be a follow up PR to automatically annotate other APIs.The motivation for this change is to increase the null safety of downstream projects using Lucene by allowing users to configure a javac plugin to lint their build. This change was tested with NullAway, which recognizes any annotation with the simple class name
@Nullable