Class FunctionDefinedByUser
java.lang.Object
com.igormaznitsa.jcp.expression.functions.AbstractFunction
com.igormaznitsa.jcp.expression.functions.FunctionDefinedByUser
- All Implemented Interfaces:
ExpressionItem
The class implements the user defined function handler (a function which name
starts with $)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private final ValueType[][]
private final String
Fields inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction
ALL_FUNCTIONS, EXECUTION_PREFIX, FUNCTION_NAME_MAP, UID_COUNTER
-
Constructor Summary
ConstructorsConstructorDescriptionFunctionDefinedByUser
(String name, int argsNumber, PreprocessorContext context) -
Method Summary
Methods inherited from class com.igormaznitsa.jcp.expression.functions.AbstractFunction
findForClass, findForName, getExpressionItemPriority, getExpressionItemType, toString
-
Field Details
-
name
-
argsNumber
private final int argsNumber -
argTypes
-
-
Constructor Details
-
FunctionDefinedByUser
-
-
Method Details
-
getName
Description copied from class:AbstractFunction
Get the function name- Specified by:
getName
in classAbstractFunction
- 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 classAbstractFunction
- Returns:
- the function arity (zero or greater)
-
execute
-
getAllowedArgumentTypes
Description copied from class:AbstractFunction
Get arrays of supported argument types- Specified by:
getAllowedArgumentTypes
in classAbstractFunction
- Returns:
- the array of argument type combinations allowed by the function handler, must not be null
-
getReference
Description copied from class:AbstractFunction
Get the function reference to be output for a help request- Specified by:
getReference
in classAbstractFunction
- Returns:
- the function information as a String, must not be null
-
getResultType
Description copied from class:AbstractFunction
Get the result type- Specified by:
getResultType
in classAbstractFunction
- Returns:
- the result type of the function, must not be null
-