org.excel4j
Interface Function

All Known Implementing Classes:
FunctionAdaptor, FunctionNamespacer, ReflectFunctionAdaptor

public interface Function

An excel function.


Method Summary
 XLObject execute(XLObject[] args)
          Execute the function.
 Argument[] getArguments()
          Get the arguments.
 java.lang.String getCategory()
          Get the function category.
 java.lang.String getHelpText()
          Get the help information.
 java.lang.String getName()
          Get the function name.
 boolean isThreadSafe()
          Indicates if a method is thread-safe.
 boolean isVolatile()
          Indicates if the function is volatile.
 

Method Detail

getName

java.lang.String getName()
Get the function name.

Returns:
String.

getArguments

Argument[] getArguments()
Get the arguments.

Returns:
Argument[].

getCategory

java.lang.String getCategory()
Get the function category.

Returns:
String.

getHelpText

java.lang.String getHelpText()
Get the help information.

Returns:
String.

execute

XLObject execute(XLObject[] args)
Execute the function.

Parameters:
args - The args.
Returns:
XLObject (result).

isVolatile

boolean isVolatile()
Indicates if the function is volatile.

Returns:
boolean.

isThreadSafe

boolean isThreadSafe()
Indicates if a method is thread-safe.

Returns:
boolean.