Package org.geotools.process.factory
Annotation Interface DescribeParameter
Annotates static method parameters for publication by
StaticMethodsProcessFactory
.- Author:
- Jody
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionThe type of object contained in the parameter in case it's a collectionThe default value for the parameter in case it's not specified.The parameter descriptionint
Maximum number of occurrences for the parameter.double
The maximum possible value acceptable for this parameter, in case it is a numeric valueString[]
Extra metadata values for this parameter which will be added into theParameter
metadata map.int
Minimum number of occurrences for the parameter.double
The minimum possible value acceptable for this parameter, in case it is a numeric value -
Field Summary
Fields
-
Field Details
-
DEFAULT_NULL
- See Also:
-
-
Element Details
-
name
String nameThe parameter name
-
-
-
description
String descriptionThe parameter description- Default:
- "[undescribed]"
-
collectionType
Class collectionTypeThe type of object contained in the parameter in case it's a collection- Default:
- java.lang.Object.class
-
min
int minMinimum 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 maxMaximum number of occurrences for the parameter. The value must be greater or equal tomin()
, 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 defaultValueThe 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
Converters
class instead. The above lookup path makes sure it's possible to define a reference to a constant for String values too (ifConverters
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"
- classic javadoc reference syntax,
-
minValue
double minValueThe minimum possible value acceptable for this parameter, in case it is a numeric value- Default:
- -1.0/0.0
-
maxValue
double maxValueThe maximum possible value acceptable for this parameter, in case it is a numeric value- Default:
- 1.0/0.0
-
meta
String[] metaExtra metadata values for this parameter which will be added into theParameter
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:
- {}
-