org.excel4j.util
Class FunctionAdaptor

java.lang.Object
  org.excel4j.util.FunctionAdaptor

All Implemented Interfaces:

Function

public abstract class FunctionAdaptor
extends java.lang.Object
implements Function

A simple adaptor for a function class.

Constructor Summary

FunctionAdaptor(java.lang.String name, Argument[] args, java.lang.String category, java.lang.String helpText)
Creates a new FunctionAdaptor object.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.excel4j.Function

execute

Constructor Detail

FunctionAdaptor

public FunctionAdaptor(java.lang.String name,
                       Argument[] args,
                       java.lang.String category,
                       java.lang.String helpText)

Creates a new FunctionAdaptor object.

Parameters:

name. -

args. -

category. -

helpText. -

Method Detail

getArguments

public Argument[] getArguments()

Description copied from interface: Function

Get the arguments.

Specified by:

getArguments in interface Function

Returns:

Argument[].

getCategory

public java.lang.String getCategory()

Description copied from interface: Function

Get the function category.

Specified by:

getCategory in interface Function

Returns:

String.

getHelpText

public java.lang.String getHelpText()

Description copied from interface: Function

Get the help information.

Specified by:

getHelpText in interface Function

Returns:

String.

getName

public java.lang.String getName()

Description copied from interface: Function

Get the function name.

Specified by:

getName in interface Function

Returns:

String.

isVolatile

public boolean isVolatile()

Description copied from interface: Function

Indicates if the function is volatile.

Specified by:

isVolatile in interface Function

Returns:

boolean.

isThreadSafe

public boolean isThreadSafe()

Description copied from interface: Function

Indicates if a method is thread-safe.

Specified by:

isThreadSafe in interface Function

Returns:

boolean.