public class DefaultFunctionDescription extends java.lang.Object implements FunctionDescription
Constructor and Description |
---|
DefaultFunctionDescription(java.lang.String name) |
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() |
public DefaultFunctionDescription(java.lang.String name)
public java.lang.String getCanonicalName()
getCanonicalName
in interface FunctionDescription
public Type getValueType()
getValueType
in interface FunctionDescription
public FunctionCategory getCategory()
getCategory
in interface FunctionDescription
public int getParameterCount()
getParameterCount
in interface FunctionDescription
public Type getParameterType(int position)
FunctionDescription
getParameterType
in interface FunctionDescription
position
- The parameter index.public boolean isParameterMandatory(int position)
isParameterMandatory
in interface FunctionDescription
public java.lang.String getDisplayName(java.util.Locale locale)
getDisplayName
in interface FunctionDescription
public java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface FunctionDescription
public boolean isVolatile()
isVolatile
in interface FunctionDescription
public boolean isInfiniteParameterCount()
isInfiniteParameterCount
in interface FunctionDescription
public java.lang.String getParameterDisplayName(int position, java.util.Locale locale)
getParameterDisplayName
in interface FunctionDescription
public java.lang.String getParameterDescription(int position, java.util.Locale locale)
getParameterDescription
in interface FunctionDescription
public java.lang.Object getDefaultValue(int position)
getDefaultValue
in interface FunctionDescription
position
-