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

Class Condition

java.lang.Object

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

All Implemented Interfaces:

FromSourceLocation, ToNode, Into<Condition>, IntoSelf<Condition>, TypeCheck

public final class Condition
extends java.lang.Object
implements TypeCheck, FromSourceLocation, ToNode, IntoSelf<Condition>

A condition is call to a rule-set function that used to determine whether a rule should be executed. Can assign the results of functions to new parameters within the current scope.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Condition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ASSIGN

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static Condition	fromNode(Node node)	Constructs a condition from the given node.
Expression	getFn()
java.util.Optional<Identifier>	getResult()	Get the identifier of the parameter that the result is assigned to.
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
Expression	toExpression()	Converts this condition to an expression reference if the condition has a result assignment.
Node	toNode()	Converts a value to a Node.
java.lang.String	toString()
Type	typeCheck(Scope<Type> scope)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.rulesengine.IntoSelf

into

Field Detail

ASSIGN

public static final java.lang.String ASSIGN

See Also:

Constant Field Values

Method Detail

fromNode

public static Condition fromNode(Node node)

Constructs a condition from the given node.

Parameters:

node - the node.

Returns:

the condition instance.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFn

public Expression getFn()

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.

getResult

public java.util.Optional<Identifier> getResult()

Get the identifier of the parameter that the result is assigned to.

Returns:

the optional identifier.

typeCheck

public Type typeCheck(Scope<Type> scope)

Specified by:

typeCheck in interface TypeCheck

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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.

toExpression

public Expression toExpression()

Converts this condition to an expression reference if the condition has a result assignment. Otherwise throws an exception.

Returns:

the result as a reference expression.