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

Class FunctionNode

java.lang.Object

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

All Implemented Interfaces:

FromSourceLocation, ToNode, ToSmithyBuilder<FunctionNode>

public final class FunctionNode
extends Object
implements FromSourceLocation, ToNode, ToSmithyBuilder<FunctionNode>

Parsed but not validated function contents containing the `fn` name and `argv`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FunctionNode.Builder

Method Summary

Modifier and Type	Method	Description
static FunctionNode.Builder	builder()	Returns a new builder instance.
boolean	equals(Object o)
static FunctionNode	fromNode(ObjectNode function)	Constructs a FunctionNode from the provided ObjectNode.
List<Expression>	getArguments()
String	getName()
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
static FunctionNode	ofExpressions(String functionName, Expression... arguments)	Constructs a FunctionNode for the given function name and arguments.
FunctionNode.Builder	toBuilder()	Returns a new builder instance for this FunctionNode.
Node	toNode()	Converts a value to a Node.
Expression	validate()	Returns an expression representing this function.

Methods inherited from class java.lang.Object

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

Method Details

ofExpressions

public static FunctionNode ofExpressions(String functionName,
 Expression... arguments)

Constructs a FunctionNode for the given function name and arguments.

Parameters:

functionName - the function name.

arguments - zero or more expressions as arguments to the function.

Returns:

the FunctionNode.

fromNode

public static FunctionNode fromNode(ObjectNode function)

Constructs a FunctionNode from the provided ObjectNode.

Parameters:

function - the node describing the function.

Returns:

the FunctionNode.

builder

public static FunctionNode.Builder builder()

Returns a new builder instance.

Returns:

the new builder instance.

toBuilder

public FunctionNode.Builder toBuilder()

Returns a new builder instance for this FunctionNode.

Specified by:

toBuilder in interface ToSmithyBuilder<FunctionNode>

Returns:

the new builder instance.

validate

public Expression validate()

Returns an expression representing this function.

Returns:

this function as an expression.

getName

public String getName()

getArguments

public List<Expression> getArguments()

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.

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