Top Description Fields Constructors Methods
org.apache.poi.ss.formula

pack-priv final Class UserDefinedFunction

extends Object
implements FreeRefFunction
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.FreeRefFunction
Imports
org.apache.poi.ss.formula.eval.FunctionNameEval, .NotImplementedFunctionException, .ValueEval, org.apache.poi.ss.formula.functions.ArrayFunction, .FreeRefFunction
Common entry point for all user-defined (non-built-in) functions (where AbstractFunctionPtg.field_2_fnc_index == 255)

Field Summary

Modifier and TypeField and Description
public static final FreeRefFunction
instance

Constructor Summary

AccessConstructor and Description
private
UserDefinedFunction()

Method Summary

Modifier and TypeMethod and Description
public ValueEval

Returns:

value
evaluate(ValueEval[]
the pre-evaluated arguments for this function. args is never null, nor are any of its elements.
args, OperationEvaluationContext
primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceback to summary
public static final FreeRefFunction instance

Constructor Detail

UserDefinedFunctionback to summary
private UserDefinedFunction()

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Parameters
args:ValueEval[]

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec:OperationEvaluationContext

primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:ValueEval

value

Annotations
@Override
Exceptions
IllegalStateException:
if first arg is not a FunctionNameEval
NotImplementedFunctionException:
if function is not implemented