Package software.amazon.smithy.rulesengine.language.visit

Class TraversingVisitor<R>

java.lang.Object

software.amazon.smithy.rulesengine.language.visit.DefaultVisitor<Stream<R>>

software.amazon.smithy.rulesengine.language.visit.TraversingVisitor<R>

Type Parameters:

R - the return type.

All Implemented Interfaces:

ExpressionVisitor<Stream<R>>, RuleValueVisitor<Stream<R>>

Direct Known Subclasses:

ValidateUriScheme

public abstract class TraversingVisitor<R>
extends DefaultVisitor<Stream<R>>

A visitor for traversing the rules and conditions of a rule-set.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.smithy.rulesengine.language.visit.ExpressionVisitor

ExpressionVisitor.Default<R>

Constructor Summary

Constructors

Constructor	Description
TraversingVisitor()

Method Summary

Modifier and Type	Method	Description
Stream<R>	getDefault()
Stream<R>	visitConditions(List<Condition> conditions)	Endpoint visitor method.
Stream<R>	visitEndpoint(Endpoint endpoint)	Endpoint visitor method.
Stream<R>	visitEndpointRule(Endpoint endpoint)	Invoked when reaching an endpoint rule.
Stream<R>	visitErrorRule(Expression error)	Invoked when reaching an error rule.
Stream<R>	visitRuleset(EndpointRuleSet ruleset)	Given an EndpointRuleSet will invoke the visitor methods for each rule.
Stream<R>	visitTreeRule(List<Rule> rules)	Invoked when reaching a tree rule.

Methods inherited from class software.amazon.smithy.rulesengine.language.visit.DefaultVisitor

visitBoolEquals, visitGetAttr, visitIsSet, visitLibraryFunction, visitLiteral, visitNot, visitRef, visitStringEquals

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TraversingVisitor

public TraversingVisitor()

Method Details

visitRuleset

public Stream<R> visitRuleset(EndpointRuleSet ruleset)

Given an EndpointRuleSet will invoke the visitor methods for each rule.

Parameters:

ruleset - the endpoint rule-set to traverse.

Returns:

a stream of values.

getDefault

public Stream<R> getDefault()

Specified by:

getDefault in class DefaultVisitor<Stream<R>>

visitTreeRule

public Stream<R> visitTreeRule(List<Rule> rules)

Description copied from interface: RuleValueVisitor

Invoked when reaching a tree rule.

Specified by:

visitTreeRule in interface RuleValueVisitor<R>

Overrides:

visitTreeRule in class DefaultVisitor<Stream<R>>

Parameters:

rules - the sub-rules within a tree rule.

Returns:

the visitor return type.

visitErrorRule

public Stream<R> visitErrorRule(Expression error)

Description copied from interface: RuleValueVisitor

Invoked when reaching an error rule.

Specified by:

visitErrorRule in interface RuleValueVisitor<R>

Overrides:

visitErrorRule in class DefaultVisitor<Stream<R>>

Parameters:

error - the error expression for the rule.

Returns:

the visitor return type.

visitEndpointRule

public Stream<R> visitEndpointRule(Endpoint endpoint)

Description copied from interface: RuleValueVisitor

Invoked when reaching an endpoint rule.

Specified by:

visitEndpointRule in interface RuleValueVisitor<R>

Overrides:

visitEndpointRule in class DefaultVisitor<Stream<R>>

Parameters:

endpoint - the endpoint of the rule.

Returns:

the visitor return type.

visitEndpoint

public Stream<R> visitEndpoint(Endpoint endpoint)

Endpoint visitor method.

Parameters:

endpoint - the endpoint to visit.

Returns:

a stream of values.

visitConditions

public Stream<R> visitConditions(List<Condition> conditions)

Endpoint visitor method.

Parameters:

conditions - the conditions to visit.

Returns:

a stream of values.