Package software.amazon.smithy.rulesengine.language.stdlib

Class Substring

java.lang.Object

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

software.amazon.smithy.rulesengine.language.stdlib.Substring

public final class Substring
extends FunctionDefinition

A rule-set function for getting the substring of a string value.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Substring()

Method Summary

Modifier and Type	Method	Description
Value	evaluate(java.util.List<Value> arguments)	Evaluate the arguments to a given function to compute a result.
java.util.List<Type>	getArguments()	The arguments to this function.
java.lang.String	getId()	The ID of this function.
Type	getReturnType()	The return type of this function definition.
static Function	ofExpression(Expression str, int startIndex, int stopIndex, java.lang.Boolean reverse)

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

Substring

public Substring()

Method Detail

getId

public java.lang.String getId()

Description copied from class: FunctionDefinition

The ID of this function.

Specified by:

getId in class FunctionDefinition

Returns:

The ID string

getArguments

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

Description copied from class: FunctionDefinition

The arguments to this function.

Specified by:

getArguments in class FunctionDefinition

Returns:

The function arguments

getReturnType

public Type getReturnType()

Description copied from class: FunctionDefinition

The return type of this function definition.

Specified by:

getReturnType in class FunctionDefinition

Returns:

The function return type

evaluate

public Value evaluate(java.util.List<Value> arguments)

Description copied from class: FunctionDefinition

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

Specified by:

evaluate in class FunctionDefinition

Returns:

The resulting value

ofExpression

public static Function ofExpression(Expression str,
                                    int startIndex,
                                    int stopIndex,
                                    java.lang.Boolean reverse)