public interface FunctionDescription
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCanonicalName() |
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() |
java.lang.String getCanonicalName()
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
-