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

Class Function

java.lang.Object

software.amazon.smithy.rulesengine.language.util.MandatorySourceLocation

software.amazon.smithy.rulesengine.language.syntax.expr.Expression

software.amazon.smithy.rulesengine.language.syntax.fn.Function

All Implemented Interfaces:

FromSourceLocation, ToNode, Into<Condition>, TypeCheck

Direct Known Subclasses:

BooleanEquals, IsSet, LibraryFunction, Not, StringEquals

public abstract class Function
extends Expression
implements Into<Condition>

Field Summary

Fields

Modifier and Type	Field	Description
protected FunctionNode	functionNode

Constructor Summary

Constructors

Constructor	Description
Function(FunctionNode functionNode)

Method Summary

Modifier and Type	Method	Description
Condition	condition()	Convert this function into a condition.
Condition	condition(java.lang.String result)	Converts this function into a condition which stores the output in the named result.
boolean	equals(java.lang.Object obj)
protected Expression	expectOneArgument()
java.util.List<Expression>	getArguments()
java.lang.String	getName()	Returns the name of this function, eg.
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
Condition	into()
Node	toNode()	Converts a value to a Node.
java.lang.String	toString()

Methods inherited from class software.amazon.smithy.rulesengine.language.syntax.expr.Expression

accept, equal, equal, fromNode, getAttr, getAttr, isSet, isValidHostLabel, isVirtualHostableS3Bucket, literal, not, of, of, of, parseArn, parseShortform, parseUrl, reference, substring, template, type, typeCheck, typeCheckLocal

Methods inherited from class java.lang.Object

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

Field Detail

functionNode

protected final FunctionNode functionNode

Constructor Detail

Function

public Function(FunctionNode functionNode)

Method Detail

condition

public Condition condition()

Convert this function into a condition.

Returns:

the function as a condition.

condition

public Condition condition(java.lang.String result)

Converts this function into a condition which stores the output in the named result.

Parameters:

result - the name of the result parameter.

Returns:

the function as a condition.

getName

public java.lang.String getName()

Returns the name of this function, eg. isSet, parseUrl

Returns:

The name

getArguments

public java.util.List<Expression> getArguments()

Returns:

The arguments to this function

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

expectOneArgument

protected Expression expectOneArgument()

getSourceLocation

public SourceLocation getSourceLocation()

Description copied from interface: FromSourceLocation

Gets the source location of a value.

Specified by:

getSourceLocation in interface FromSourceLocation

Overrides:

getSourceLocation in class MandatorySourceLocation

Returns:

Returns the source location of the value.

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in class Expression

hashCode

public int hashCode()

Specified by:

hashCode in class Expression

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.

into

public Condition into()

Specified by:

into in interface Into<Condition>