org.excel4j.reflect
Class FunctionAttributes

java.lang.Object
  org.excel4j.reflect.FunctionAttributes

public class FunctionAttributes
extends java.lang.Object

A set of attributes for a method.

Constructor Summary

FunctionAttributes()
Creates a new FunctionAttributes object.

FunctionAttributes(java.lang.String helpText, java.lang.String[] argNames, java.lang.String[] argHelp)
Creates a new FunctionAttributes object.

Method Summary

java.lang.String[]	getArgHelp() Gets the argument help texts for a function.
java.lang.String[]	getArgNames() Gets the argument names for a function.
java.lang.String	getCategory() Get the category for a function.
java.lang.String	getHelpText() Gets the help text for a function.
boolean	isStrict() Indicates if the argument supports optional arguments.
boolean	isThreadSafe() Indicates if the function is thread-safe.
boolean	isVolatile() Indicates if the function is volatile.
void	setArgHelp(java.lang.String[] argHelp) Set the argument help texts for a function.
void	setArgNames(java.lang.String[] argNames) Sets the argument names for a function.
void	setCategory(java.lang.String category) Set the category for a function.
void	setHelpText(java.lang.String helpText) Sets the help text for a function.
void	setStrict(boolean isStrict) Sets the strict mode.
void	setThreadSafe(boolean isThreadSafe) Sets the thread-safe flag.
void	setVolatile(boolean isVolatile) Sets the volatile flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionAttributes

public FunctionAttributes()

Creates a new FunctionAttributes object.

FunctionAttributes

public FunctionAttributes(java.lang.String helpText,
                          java.lang.String[] argNames,
                          java.lang.String[] argHelp)

Creates a new FunctionAttributes object.

Parameters:

helpText. -

argNames. -

argHelp. -

Method Detail

getHelpText

public java.lang.String getHelpText()

Gets the help text for a function.

Returns:

String.

setHelpText

public void setHelpText(java.lang.String helpText)

Sets the help text for a function.

Parameters:

helpText. -

getArgNames

public java.lang.String[] getArgNames()

Gets the argument names for a function.

Returns:

String[].

setArgNames

public void setArgNames(java.lang.String[] argNames)

Sets the argument names for a function.

Parameters:

argNames. -

getArgHelp

public java.lang.String[] getArgHelp()

Gets the argument help texts for a function.

Returns:

String.

setArgHelp

public void setArgHelp(java.lang.String[] argHelp)

Set the argument help texts for a function.

Parameters:

argHelp. -

isStrict

public boolean isStrict()

Indicates if the argument supports optional arguments.

Returns:

boolean.

setStrict

public void setStrict(boolean isStrict)

Sets the strict mode.

Parameters:

isStrict. -

isVolatile

public boolean isVolatile()

Indicates if the function is volatile.

Returns:

boolean.

setVolatile

public void setVolatile(boolean isVolatile)

Sets the volatile flag.

Parameters:

isVolatile. -

isThreadSafe

public boolean isThreadSafe()

Indicates if the function is thread-safe.

Returns:

boolean.

setThreadSafe

public void setThreadSafe(boolean isThreadSafe)

Sets the thread-safe flag.

Parameters:

isThreadSafe. -

getCategory

public java.lang.String getCategory()

Get the category for a function.

Returns:

String.

setCategory

public void setCategory(java.lang.String category)

Set the category for a function.

Parameters:

category. -