Make IndexSearcher#getSlices final and clarify docs #12718
Merged
Conversation
This file contains 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
IndexSearcher exposes a public getSlices method, that is used to retriefve the slices that the searcher executes queries against, as well as slices, which is supposed to be overridden to customize the creation of slices. I believe that getSlices should be final: there is no reason to override the method. Also, it is too easy to confuse the two and end up overriding the wrong one by mistake.
javanna
commented
Oct 24, 2023
| * | ||
| * @lucene.experimental | ||
| */ | ||
| public LeafSlice[] getSlices() { | ||
| public final LeafSlice[] getSlices() { |
There was a problem hiding this comment.
I wonder if we are good backporting this to 9.x given that the method is experimental. I don't see a reason why one would override getSlices on purpose.
javanna
commented
Oct 24, 2023
| * method from constructor, which is a bad practice. This is {@code null} if no executor is | ||
| * provided | ||
| * method from constructor, which is a bad practice. Always non-null, regardless of whether an | ||
| * executor is provided or not. |
There was a problem hiding this comment.
the behaviour here has recently changed, but the docs were out of date.
shubhamvishu
approved these changes
Oct 24, 2023
|
thanks @s1monw for the review! I will add a changes entry and merge this. |
javanna
added a commit
that referenced
this pull request
Oct 26, 2023
IndexSearcher exposes a public getSlices method, that is used to retrieve the slices that the searcher executes queries against, as well as slices, which is supposed to be overridden to customize the creation of slices. I believe that getSlices should be final: there is no reason to override the method. Also, it is too easy to confuse the two and end up overriding the wrong one by mistake.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
IndexSearcher exposes a public getSlices method, that is used to retriefve the slices that the searcher executes queries against, as well as slices, which is supposed to be overridden to customize the creation of slices.
I believe that getSlices should be final: there is no reason to override the method. Also, it is too easy to confuse the two and end up overriding the wrong one by mistake.
This change was discussed here: #12606 (comment) .