com.igormaznitsa.jcp.expression.functions

Class FunctionIS

java.lang.Object

com.igormaznitsa.jcp.expression.functions.AbstractFunction

com.igormaznitsa.jcp.expression.functions.FunctionIS

All Implemented Interfaces:

ExpressionItem

public final class FunctionIS
extends AbstractFunction

The class implements the IS function handler

Field Summary

Fields

Modifier and Type	Field and Description
private static ValueType[][]	SIGNATURES

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

ALL_FUNCTIONS, EXECUTION_PREFIX, FUNCTION_NAME_MAP, UID_COUNTER

Constructor Summary

Constructors

Constructor and Description
FunctionIS()

Method Summary

Modifier and Type	Method and Description
Value	executeStrAny(PreprocessorContext context, Value varName, Value value)
ValueType[][]	getAllowedArgumentTypes() Get arrays of supported argument types
int	getArity() Get the function arity
java.lang.String	getName() Get the function name
java.lang.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

Field Detail

SIGNATURES

private static final ValueType[][] SIGNATURES

Constructor Detail

FunctionIS

public FunctionIS()

Method Detail

getName

public java.lang.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

executeStrAny

public Value executeStrAny(PreprocessorContext context,
                           Value varName,
                           Value value)

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)

getAllowedArgumentTypes

@MustNotContainNull
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 java.lang.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