Package org.geotools.process.factory

Annotation Type DescribeParameter

  • @Retention(RUNTIME)
@Target(PARAMETER)
public @interface DescribeParameter
    Annotates static method parameters for publication by StaticMethodsProcessFactory.
    Author:
    Jody

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static String DEFAULT_NULL  

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The parameter name

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      Class collectionType
      The type of object contained in the parameter in case it's a collection
      String defaultValue
      The default value for the parameter in case it's not specified.
      String description
      The parameter description
      int max
      Maximum number of occurrences for the parameter.
      double maxValue
      The maximum possible value acceptable for this parameter, in case it is a numeric value
      String[] meta
      Extra metadata values for this parameter which will be added into the Parameter metadata map.
      int min
      Minimum number of occurrences for the parameter.
      double minValue
      The minimum possible value acceptable for this parameter, in case it is a numeric value

    • Field Detail

      • DEFAULT_NULL

        static final String DEFAULT_NULL

    • Element Detail

      • name

        String name
        The parameter name

      • description

        String description
        The parameter description
        Default:
        "[undescribed]"

      • collectionType

        Class collectionType
        The type of object contained in the parameter in case it's a collection
        Default:
        java.lang.Object.class

      • min

        int min
        Minimum number of occurrences for the parameter. A value of 0 means the parameter is optional, a value greater than one makes sense only if the parameter is a collection, in which case the number of items of the collections will be compared against the minimum value.
        Default:
        -1

      • max

        int max
        Maximum number of occurrences for the parameter. The value must be greater or equal to min(), a value greater than one makes sense only if the parameter is a collection, in which case the number of items of the collections will be compared against the maximum value.
        Default:
        -1

      • defaultValue

        String defaultValue
        The default value for the parameter in case it's not specified. The string value will be first interpreted as a reference to a constant defined with the following two syntaxes:
        • classic javadoc reference syntax, com.company.MyClass#THE_CONSTANT
        • simple name, in which case the constant will be searched in the process class itself first, and in the parameter type class later
        If the above does not work the string value will be converted to the target type using the Converters class instead. The above lookup path makes sure it's possible to define a reference to a constant for String values too (if Converters were to be used right away the value of the default itself would be used as the default value).

        If none of the above heuristics works an exception will be thrown.

        Default:
        "THIS IS THE NULL VALUE FOR THE DEFAULT ATTRIBUTE"

      • minValue

        double minValue
        The minimum possible value acceptable for this parameter, in case it is a numeric value
        Default:
        -1.0/0.0

      • maxValue

        double maxValue
        The maximum possible value acceptable for this parameter, in case it is a numeric value
        Default:
        1.0/0.0

      • meta

        String[] meta
        Extra metadata values for this parameter which will be added into the Parameter metadata map. Each string should be in the key=value form, if not, the string will be taken as the key and the value will be null.
        Default:
        {}