Added Optional method in SymbolReference #3740
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
jlerbsc
reviewed
Oct 31, 2022
| this.correspondingDeclaration = correspondingDeclaration; | ||
| } | ||
|
|
||
| /** | ||
| * Create a solve reference to the given symbol. | ||
| */ | ||
| public static <S extends ResolvedDeclaration, S2 extends S> SymbolReference<S> solved(S2 symbolDeclaration) { | ||
| return new SymbolReference<S>(Optional.of(symbolDeclaration)); | ||
| return new SymbolReference<>(symbolDeclaration); |
There was a problem hiding this comment.
Can this method declaration be simplified?
There was a problem hiding this comment.
It's a good question. Simplifying is not easy, since it impacts the api. For example, tried to do that in commit c4e42df but it may break the current API.
jlerbsc
reviewed
Oct 31, 2022
| } | ||
|
|
||
| /** | ||
| * Create an unsolved reference specifying the type of the value expected. | ||
| */ | ||
| public static <S extends ResolvedDeclaration, S2 extends S> SymbolReference<S> unsolved(Class<S2> clazz) { | ||
| return new SymbolReference<>(Optional.empty()); | ||
| return new SymbolReference<>(null); |
There was a problem hiding this comment.
Can this method declaration be simplified?
There was a problem hiding this comment.
It's a good question. Simplifying is not easy, since it impacts the api.
I think the best approach would be leave it as it is, and consider it as deprecated :)
Codecov Report
@@ Coverage Diff @@
## master #3740 +/- ##
===============================================
+ Coverage 57.315% 57.319% +0.004%
- Complexity 2670 2672 +2
===============================================
Files 635 635
Lines 33553 33559 +6
Branches 5784 5787 +3
===============================================
+ Hits 19231 19236 +5
- Misses 12270 12271 +1
Partials 2052 2052
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
jlerbsc
added
the
PR: Changed
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.
When i was working with the code noticed an inconsistency in SymbolReference method comparing with other classes.
Most of the methods that can return null return an optional to allow the programmer to check when the value is present or not.
This method was not following this guideline requiring the use of an additional method isSolved() before the call of getCorrespondingDeclaration().
This Pull Request adds support for the Optional, allowing a more consistent pattern between methods.
This PR is similar to #3044 BUT does not affect the Public API.
Let me know your thoughts!