software.amazon.smithy.model.selector

Interface Selector

public interface Selector

Matches a set of shapes using a selector expression.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Selector.Runner Deprecated. This class is no longer necessary. It was originally intended to allow more customization to how selectors are executed against a model, but this has proven unnecessary.
static class	Selector.ShapeMatch Represents a selector match found in the model.

Field Summary

Fields

Modifier and Type	Field and Description
static Selector	IDENTITY A selector that always returns all provided values.

Method Summary

Modifier and Type	Method and Description
default void	consumeMatches(Model model, java.util.function.Consumer<Selector.ShapeMatch> shapeMatchConsumer) Matches a selector to a set of shapes and receives each matched shape with the variables that were set when the shape was matched.
static Selector	fromNode(Node node) Creates a Selector from a Node.
java.util.stream.Stream<Selector.ShapeMatch>	matches(Model model) Returns a stream of Selector.ShapeMatch objects for each match found in a model.
static Selector	parse(java.lang.String expression) Parses a selector expression.
default Selector.Runner	runner() Deprecated.
default java.util.Set<Shape>	select(Model model) Matches a selector to a model.
java.util.stream.Stream<Shape>	shapes(Model model) Returns a stream of shapes in a model that match the selector.

Field Detail

IDENTITY

static final Selector IDENTITY

A selector that always returns all provided values.

Method Detail

parse

static Selector parse(java.lang.String expression)

Parses a selector expression.

Parameters:

expression - Expression to parse.

Returns:

Returns the parsed Selector.

fromNode

static Selector fromNode(Node node)

Creates a Selector from a Node.

Parameters:

node - Node to parse.

Returns:

Returns the created selector.

Throws:

SourceException - on error.

select

default java.util.Set<Shape> select(Model model)

Matches a selector to a model.

Parameters:

model - Model used to resolve shapes with.

Returns:

Returns the matching shapes.

consumeMatches

default void consumeMatches(Model model,
                            java.util.function.Consumer<Selector.ShapeMatch> shapeMatchConsumer)

Matches a selector to a set of shapes and receives each matched shape with the variables that were set when the shape was matched.

Parameters:

model - Model to select shapes from.

shapeMatchConsumer - Receives each matched shape and the vars available when the shape was matched.

shapes

java.util.stream.Stream<Shape> shapes(Model model)

Returns a stream of shapes in a model that match the selector.

Parameters:

model - Model to match the selector against.

Returns:

Returns a stream of matching shapes.

matches

java.util.stream.Stream<Selector.ShapeMatch> matches(Model model)

Returns a stream of Selector.ShapeMatch objects for each match found in a model.

Parameters:

model - Model to match the selector against.

Returns:

Returns a stream of ShapeMatch objects.

runner

@Deprecated
default Selector.Runner runner()

Deprecated.

Creates a Selector Runner, used to customize how a selector is executed.

Returns:

Returns the created runner.