Package org.apache.poi.ss.formula
Class UserDefinedFunction
- java.lang.Object
-
- org.apache.poi.ss.formula.UserDefinedFunction
-
- All Implemented Interfaces:
FreeRefFunction
public final class UserDefinedFunction extends Object implements FreeRefFunction
Common entry point for all user-defined (non-built-in) functions (whereAbstractFunctionPtg.field_2_fnc_index== 255)
-
-
Field Summary
Fields Modifier and Type Field Description static FreeRefFunctioninstance
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ValueEvalevaluate(ValueEval[] args, OperationEvaluationContext ec)
-
-
-
Field Detail
-
instance
public static final FreeRefFunction instance
-
-
Method Detail
-
evaluate
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)
- Specified by:
evaluatein interfaceFreeRefFunction- Parameters:
args- the pre-evaluated arguments for this function. args is nevernull, nor are any of its elements.ec- primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.- Returns:
- value
- Throws:
IllegalStateException- if first arg is not aFunctionNameEvalNotImplementedFunctionException- if function is not implemented
-
-