FunctionDescription (libformula JavaDoc)

Interface FunctionDescription

public interface FunctionDescription extends Serializable

A static definition of the function's parameters, return values etc. This is a support class with emphasis on GUI tools. However, the parameter declarations are also used when filling in the parameter values. Functions have a defined set of known parameters and can have a unlimited number of optional parameters. If a function declares at least one parameter and declares that its parameter list is infinite, then the last parameter type is used on all remaining parameters.

Author: Thomas Morgner

Method Summary
String	getCanonicalName()
FunctionCategory	getCategory()
Object	getDefaultValue(int position) Returns the default value for an optional parameter.
String	getDescription(Locale locale)
String	getDisplayName(Locale locale)
int	getParameterCount()
String	getParameterDescription(int position, Locale locale)
String	getParameterDisplayName(int position, Locale locale)
Type	getParameterType(int position) Returns the parameter type at the given position using the function metadata.
Type	getValueType()
boolean	isInfiniteParameterCount()
boolean	isParameterMandatory(int position) Defines, whether the parameter at the given position is mandatory.
boolean	isVolatile()

String

Object

getDefaultValue(int position)

Returns the default value for an optional parameter.

String

getDescription(Locale locale)

String

getDisplayName(Locale locale)

int

getParameterCount()

String

getParameterDescription(int position, Locale locale)

String

getParameterDisplayName(int position, Locale locale)

Type

getParameterType(int position)

Returns the parameter type at the given position using the function metadata.

Type

getValueType()

boolean

isInfiniteParameterCount()

boolean

isParameterMandatory(int position)

Defines, whether the parameter at the given position is mandatory.

boolean

Returns the default value for an optional parameter. If the value returned here is null, then this either means, that the parameter is mandatory or that the default value is computed by the expression itself.

Parameters: position

Returns:

getDescription

getDisplayName

getParameterCount

getParameterDescription

getParameterDisplayName

getParameterType

Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;

Parameters: position The parameter index.

Returns: The parameter type.

getValueType

isInfiniteParameterCount

isParameterMandatory

Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while optional parameters need not to be filled in.

Returns: