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

Class ErrorRule

java.lang.Object

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

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

All Implemented Interfaces:

FromSourceLocation, ToNode, TypeCheck

public final class ErrorRule
extends Rule

A rule-set rule that is used to indicate an error in evaluation.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.smithy.rulesengine.language.syntax.rule.Rule

Rule.Builder

Field Summary

Fields inherited from class software.amazon.smithy.rulesengine.language.syntax.rule.Rule

DOCUMENTATION, ENDPOINT, ERROR, RULES, TREE, TYPE

Constructor Summary

Constructors

Constructor	Description
ErrorRule(Rule.Builder builder, Expression error)

Method Summary

Modifier and Type	Method	Description
<T> T	accept(RuleValueVisitor<T> visitor)	Invoke the RuleValueVisitor functions for this Rule.
boolean	equals(Object object)
Expression	getError()	Gets the error expression to return when reaching this rule.
int	hashCode()
String	toString()
protected Type	typecheckValue(Scope<Type> scope)
protected void	withValueNode(ObjectNode.Builder builder)

Methods inherited from class software.amazon.smithy.rulesengine.language.syntax.rule.Rule

builder, builder, fromNode, getConditions, getDocumentation, getSourceLocation, toNode, typeCheck, withConditions

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorRule

public ErrorRule(Rule.Builder builder,
 Expression error)

Method Details

getError

public Expression getError()

Gets the error expression to return when reaching this rule.

Returns:

the error expression.

accept

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

Description copied from class: Rule

Invoke the RuleValueVisitor functions for this Rule.

Specified by:

accept in class Rule

Type Parameters:

T - the visitor return type.

Parameters:

visitor - the visitor to be invoked.

Returns:

the return value of the visitor.

typecheckValue

protected Type typecheckValue(Scope<Type> scope)

Specified by:

typecheckValue in class Rule

withValueNode

protected void withValueNode(ObjectNode.Builder builder)

Specified by:

withValueNode in class Rule

toString

public String toString()

Overrides:

toString in class Rule

equals

public boolean equals(Object object)

Overrides:

equals in class Rule

hashCode

public int hashCode()

Overrides:

hashCode in class Rule