Class DefaultFunctionDescription

Method Details

• getCanonicalName

  public String getCanonicalName()

  Specified by:

  getCanonicalName in interface FunctionDescription

• getValueType

  public Type getValueType()

  Specified by:

  getValueType in interface FunctionDescription

• getCategory

  public FunctionCategory getCategory()

  Specified by:

  getCategory in interface FunctionDescription

• getParameterCount

  public int getParameterCount()

  Specified by:

  getParameterCount in interface FunctionDescription

• getParameterType

  public Type getParameterType(int position)

  Description copied from interface: FunctionDescription

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

  Specified by:

  getParameterType in interface FunctionDescription

  Parameters:

  position - The parameter index.

  Returns:

  The parameter type.

• isParameterMandatory

  public boolean isParameterMandatory(int position)

  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.

  Specified by:

  isParameterMandatory in interface FunctionDescription

  Returns:

• getDisplayName

  public String getDisplayName(Locale locale)

  Specified by:

  getDisplayName in interface FunctionDescription

• getDescription

  public String getDescription(Locale locale)

  Specified by:

  getDescription in interface FunctionDescription

• isVolatile

  public boolean isVolatile()

  Specified by:

  isVolatile in interface FunctionDescription

• isInfiniteParameterCount

  public boolean isInfiniteParameterCount()

  Specified by:

  isInfiniteParameterCount in interface FunctionDescription

• getParameterDisplayName

  public String getParameterDisplayName(int position, Locale locale)

  Specified by:

  getParameterDisplayName in interface FunctionDescription

• getParameterDescription

  public String getParameterDescription(int position, Locale locale)

  Specified by:

  getParameterDescription in interface FunctionDescription

• getDefaultValue

  public Object getDefaultValue(int position)

  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.

  Specified by:

  getDefaultValue in interface FunctionDescription

  Parameters:

  position -

  Returns: