org.zkoss.poi.ss.formula

Class UserDefinedFunction

java.lang.Object

org.zkoss.poi.ss.formula.UserDefinedFunction

All Implemented Interfaces:

FreeRefFunction

public final class UserDefinedFunction
extends java.lang.Object
implements FreeRefFunction

Common entry point for all user-defined (non-built-in) functions (where AbstractFunctionPtg.field_2_fnc_index == 255)

Author:

Josh Micich, Petr Udalau - Improved resolving of UDFs through the ToolPacks.

Field Summary

Fields

Modifier and Type	Field and Description
static FreeRefFunction	instance

Method Summary

Modifier and Type	Method and Description
ValueEval	evaluate(ValueEval[] args, OperationEvaluationContext ec)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

public static final FreeRefFunction instance

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)

Specified by:

evaluate in interface FreeRefFunction

Parameters:

args - the pre-evaluated arguments for this function. args is never null, 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:

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).