|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FunctionDescription
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.
Method Summary | |
---|---|
FunctionCategory |
getCategory()
|
java.lang.Object |
getDefaultValue(int position)
Returns the default value for an optional parameter. |
java.lang.String |
getDescription(java.util.Locale locale)
|
java.lang.String |
getDisplayName(java.util.Locale locale)
|
int |
getParameterCount()
|
java.lang.String |
getParameterDescription(int position,
java.util.Locale locale)
|
java.lang.String |
getParameterDisplayName(int position,
java.util.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()
|
Method Detail |
---|
java.lang.String getDisplayName(java.util.Locale locale)
java.lang.String getDescription(java.util.Locale locale)
boolean isVolatile()
Type getValueType()
FunctionCategory getCategory()
int getParameterCount()
boolean isInfiniteParameterCount()
Type getParameterType(int position)
position
- The parameter index.
java.lang.String getParameterDisplayName(int position, java.util.Locale locale)
java.lang.String getParameterDescription(int position, java.util.Locale locale)
boolean isParameterMandatory(int position)
java.lang.Object getDefaultValue(int position)
position
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |