com.igormaznitsa.jcp.expression.functions

Class FunctionEVALFILE

java.lang.Object

com.igormaznitsa.jcp.expression.functions.AbstractFunction

com.igormaznitsa.jcp.expression.functions.FunctionEVALFILE

All Implemented Interfaces:

ExpressionItem

public class FunctionEVALFILE
extends AbstractFunction

The Function makes preprocessing of a file and return result as a string value. It uses the current preprocessor context as the context for preprocessing the file.

Field Summary

Fields

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

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

ALL_FUNCTIONS, EXECUTION_PREFIX, UID_COUNTER

Constructor Summary

Constructors

Constructor and Description
FunctionEVALFILE()

Method Summary

Modifier and Type	Method and Description
Value	executeStr(PreprocessorContext context, Value strfilePath)
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

ARG_TYPES

private static final ValueType[][] ARG_TYPES

Constructor Detail

FunctionEVALFILE

public FunctionEVALFILE()

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

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

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

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

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

executeStr

public Value executeStr(PreprocessorContext context,
                        Value strfilePath)