|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Target(value=PARAMETER) public @interface DescribeParameter
Annotates static method parameters for publication by StaticMethodsProcessFactory
.
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 |
---|
public abstract String name
public abstract String description
public abstract Class collectionType
public abstract int min
public abstract int max
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.
public abstract String defaultValue
com.company.MyClass#THE_CONSTANT
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.
public abstract double minValue
public abstract double maxValue
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |