Package com.aquima.interactions.expressions.functions.str

Class SubString

java.lang.Object

com.aquima.interactions.expressions.functions.str.SubString

All Implemented Interfaces:

IFunction, Serializable

public class SubString
extends Object
implements IFunction

This function returns the string starting at the start index and ending at either the end index or the end of the string if the end index is not provided.

Since:

9.6

Author:

g.graat

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubString()
SubString(boolean useEndIndex)

Method Summary

Modifier and Type	Method	Description
Type	determineResultType(ISemanticNode... arguments)	This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
IValue	evaluate(IArgumentList arguments)	This method should execute the function using the supplied arguments.
IArgumentType[]	getArguments()	This method returns an array containing the definitions of the arguments the function expects.
String	getName()	This method returns the name of the function.
boolean	isDeprecated()	This method returns a boolean indicating that the function is deprecated and should no longer be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubString

public SubString()

SubString

public SubString(boolean useEndIndex)

Method Detail

getArguments

public IArgumentType[] getArguments()

Description copied from interface: IFunction

This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.

Specified by:

getArguments in interface IFunction

Returns:

Array containing the definitions of the parameters.

evaluate

public IValue evaluate(IArgumentList arguments)

Description copied from interface: IFunction

This method should execute the function using the supplied arguments.

Specified by:

evaluate in interface IFunction

Parameters:

arguments - The arguments for the function.

Returns:

The result of the function.

getName

public String getName()

Description copied from interface: IFunction

This method returns the name of the function.

Specified by:

getName in interface IFunction

Returns:

the name of the function.

determineResultType

public Type determineResultType(ISemanticNode... arguments)

Description copied from interface: IFunction

This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.

Specified by:

determineResultType in interface IFunction

Parameters:

arguments - The type information of the parameters.

Returns:

The result type of the function.

isDeprecated

public boolean isDeprecated()

Description copied from interface: IFunction

This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.

Specified by:

isDeprecated in interface IFunction

Returns:

A message indicating that the function is deprecated.