Improve Selector usability #726
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
kstich
reviewed
Mar 3, 2021
smithy-model/src/main/java/software/amazon/smithy/model/selector/WrappedSelector.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/selector/WrappedSelector.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/selector/WrappedSelector.java
Outdated
Show resolved
Hide resolved
This commit improves the usability of Selectors by adding new methods to the Selector interface and by deprecating its runner functionality. The new methods include methods to stream matching shapes, stream matches, and consume matches. Streaming matches and shapes requires a minimal amount of buffering, and they provide the ability to more easily perform checks like determine if any shapes in a model match a selector. If all matching shapes are necessary, calling select is preferred. If consuming matches can be done in a way that is push-based (e.g., writing to CLI output), then using consumeMatches is preferred to matches. The previous runner() method of Selector is now deprecated and just delegates calls back to the Selector. runner() was initially intended to allow for the customization of the environment in which a selector is executed, but this design turned out to be unnecessary, and as such, the need to create a runner and use a kind of builder interface to use Selectors made them awkward to work with for no benefit. A final change is made to implement an IdentitySelector to optimize matching all shapes in a model.
mtdowling
force-pushed
the
selector-usability
branch
from
b799315 to
6f6f006
Compare
kstich
approved these changes
Mar 4, 2021
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.
This commit improves the usability of Selectors by adding new methods to
the Selector interface and by deprecating its runner functionality. The
new methods include methods to stream matching shapes, stream matches,
and consume matches. Streaming matches and shapes requires a minimal
amount of buffering, and they provide the ability to more easily perform
checks like determine if any shapes in a model match a selector. If all
matching shapes are necessary, calling select is preferred. If consuming
matches can be done in a way that is push-based (e.g., writing to CLI
output), then using consumeMatches is preferred to matches.
The previous runner() method of Selector is now deprecated and just
delegates calls back to the Selector. runner() was initially intended to
allow for the customization of the environment in which a selector is
executed, but this design turned out to be unnecessary, and as such, the
need to create a runner and use a kind of builder interface to use
Selectors made them awkward to work with for no benefit.
A final change is made to implement an IdentitySelector to optimize
matching all shapes in a model.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.