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

Class FunctionDefinition

java.lang.Object

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

Direct Known Subclasses:

AwsIsVirtualHostableS3Bucket, AwsPartition, IsValidHostLabel, ParseArn, ParseUrl, Substring, UriEncode

public abstract class FunctionDefinition
extends Object

An abstract definition of a rule-engine function.

Constructor Summary

Constructors

Constructor	Description
FunctionDefinition()

Method Summary

Modifier and Type	Method	Description
abstract Value	evaluate(List<Value> arguments)	Evaluate the arguments to a given function to compute a result.
abstract List<Type>	getArguments()	The arguments to this function.
abstract String	getId()	The ID of this function.
abstract Type	getReturnType()	The return type of this function definition.

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionDefinition

public FunctionDefinition()

Method Details

getId

public abstract String getId()

The ID of this function.

Returns:

The ID string

getArguments

public abstract List<Type> getArguments()

The arguments to this function.

Returns:

The function arguments

getReturnType

public abstract Type getReturnType()

The return type of this function definition.

Returns:

The function return type

evaluate

public abstract Value evaluate(List<Value> arguments)

Evaluate the arguments to a given function to compute a result.

Returns:

The resulting value