org.geotools.process.factory
Annotation Type DescribeParameter


@Retention(value=RUNTIME)
@Target(value=PARAMETER)
public @interface DescribeParameter

Annotates static method parameters for publication by StaticMethodsProcessFactory.

Author:
Jody

Required Element Summary
 String name
          The parameter name
 
Optional Element Summary
 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
 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
 

Element Detail

name

public abstract String name
The parameter name

Returns:

description

public abstract String description
The parameter description

Returns:
Default:
"[undescribed]"

collectionType

public abstract Class collectionType
The type of object contained in the parameter in case it's a collection

Returns:
Default:
java.lang.Object.class

min

public abstract 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.

Returns:
Default:
-1

max

public abstract 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.

Returns:
Default:
-1

defaultValue

public abstract 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: 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.

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

minValue

public abstract double minValue
The minimum possible value acceptable for this parameter, in case it is a numeric value

Returns:
Default:
-1d/0d

maxValue

public abstract double maxValue
The maximum possible value acceptable for this parameter, in case it is a numeric value

Returns:
Default:
1d/0d


Copyright © 1996-2014 Geotools. All Rights Reserved.