Package software.amazon.smithy.rulesengine.language.syntax.rule

Class Rule

java.lang.Object

software.amazon.smithy.rulesengine.language.syntax.rule.Rule

All Implemented Interfaces:

FromSourceLocation, ToNode, TypeCheck

Direct Known Subclasses:

EndpointRule, ErrorRule, TreeRule

public abstract class Rule
extends Object
implements TypeCheck, ToNode, FromSourceLocation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Rule.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENTATION
static final String	ENDPOINT
static final String	ERROR
static final String	RULES
static final String	TREE
static final String	TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Rule(Rule.Builder builder)

Method Summary

Modifier and Type	Method	Description
abstract <T> T	accept(RuleValueVisitor<T> visitor)
static Rule.Builder	builder()
static Rule.Builder	builder(FromSourceLocation sourceLocation)
boolean	equals(Object o)
static Rule	fromNode(Node node)
List<Condition>	getConditions()
Optional<String>	getDocumentation()
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
Node	toNode()	Converts a value to a Node.
String	toString()
Type	typeCheck(Scope<Type> scope)
protected abstract Type	typecheckValue(Scope<Type> scope)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DOCUMENTATION

public static final String DOCUMENTATION

See Also:

• Constant Field Values

ENDPOINT

public static final String ENDPOINT

See Also:

• Constant Field Values

ERROR

public static final String ERROR

See Also:

• Constant Field Values

TREE

public static final String TREE

See Also:

• Constant Field Values

RULES

public static final String RULES

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

Rule

protected Rule(Rule.Builder builder)

Method Details

builder

public static Rule.Builder builder()

builder

public static Rule.Builder builder(FromSourceLocation sourceLocation)

fromNode

public static Rule fromNode(Node node)

accept

public abstract <T> T accept(RuleValueVisitor<T> visitor)

getSourceLocation

public SourceLocation getSourceLocation()

Description copied from interface: FromSourceLocation

Gets the source location of a value.

Specified by:

getSourceLocation in interface FromSourceLocation

Returns:

Returns the source location of the value.

getConditions

public List<Condition> getConditions()

typeCheck

public Type typeCheck(Scope<Type> scope)

Specified by:

typeCheck in interface TypeCheck

typecheckValue

protected abstract Type typecheckValue(Scope<Type> scope)

getDocumentation

public Optional<String> getDocumentation()

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object