com.igormaznitsa.jcp.expression.functions

Class FunctionDefinedByUser

java.lang.Object

com.igormaznitsa.jcp.expression.functions.AbstractFunction

com.igormaznitsa.jcp.expression.functions.FunctionDefinedByUser

All Implemented Interfaces:

ExpressionItem

public final class FunctionDefinedByUser
extends AbstractFunction

The class implements the user defined function handler (a function which name begins with $)

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Field Summary

Fields inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction

ALL_FUNCTIONS, EXECUTION_PREFIX, UID_COUNTER

Constructor Summary

Constructors

Constructor and Description
FunctionDefinedByUser(String name, int argsNumber, PreprocessorContext context)

Method Summary

Modifier and Type	Method and Description
Value	execute(PreprocessorContext context, Value[] values)
ValueType[][]	getAllowedArgumentTypes() Get arrays of supported argument types
int	getArity() Get the function arity
String	getName() Get the function name
String	getReference() Get the function reference to be output for a help request
ValueType	getResultType() Get the result type

Methods inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction

findForClass, findForName, getExpressionItemPriority, getExpressionItemType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionDefinedByUser

public FunctionDefinedByUser(String name,
                             int argsNumber,
                             PreprocessorContext context)

Method Detail

getName

public String getName()

Description copied from class: AbstractFunction

Get the function name

Specified by:

getName in class AbstractFunction

Returns:

the function name in lower case, must not be null

getArity

public int getArity()

Description copied from class: AbstractFunction

Get the function arity

Specified by:

getArity in class AbstractFunction

Returns:

the function arity (zero or greater)

execute

public Value execute(PreprocessorContext context,
                     Value[] values)

getAllowedArgumentTypes

public ValueType[][] getAllowedArgumentTypes()

Description copied from class: AbstractFunction

Get arrays of supported argument types

Specified by:

getAllowedArgumentTypes in class AbstractFunction

Returns:

the array of argument type combinations allowed by the function handler, must not be null

getReference

public String getReference()

Description copied from class: AbstractFunction

Get the function reference to be output for a help request

Specified by:

getReference in class AbstractFunction

Returns:

the function information as a String, must not be null

getResultType

public ValueType getResultType()

Description copied from class: AbstractFunction

Get the result type

Specified by:

getResultType in class AbstractFunction

Returns:

the result type of the function, must not be null