Annotation Interface Parameter
WARNING: although not deprecated (to avoid warnings that are of little use), this annotation is subject to removal, along with the API discovery tools that used it.
Marks fields of typically parameter objects / builders which are intended to be exposed to the user (through reflection based dynamic API discovery) to modify
Note that annotated elements (fields) must be annotated with Description
annotation
Note that an associated setter method named from the annotated field must exist. Setting the parameter value is
done through the setter method. (eg. if an int
field called count
is annotated as a
Parameter
there must be a method with signature int count(int)
to be used as a setter. The
method naming convention reflects the typical usage in builders.
Please note that this annotation is marked with @Beta annotation, so it can be subject of incompatible changes or removal in later releases.
-
Required Element Summary
-
Optional Element Summary
-
Element Details
-
order
int orderOrder info for the listed parameters.The parameter discovery will list parameters by this value in increasing order.
- Returns:
- Order
-
-
-
minDouble
double minDoubleMinimal double value accepted (inclusive).This is an optional parameter used as a hint for certain user interfaces. Value is only considered when smaller than the default
Double.NEGATIVE_INFINITY
is specified for floating point parameter types.- Returns:
- Minimal
double
value accepted
- Default:
- -1.0/0.0
-
maxDouble
double maxDoubleMaximal double value accepted (inclusive).This is an optional parameter used as a hint for certain user interfaces. Value is only considered when larger than the default
Double.POSITIVE_INFINITY
is specified for floating point parameter types.- Returns:
- Maximal
double
value accepted
- Default:
- 1.0/0.0
-
minLong
long minLongMinimal long value accepted (inclusive).This is an optional parameter used as a hint for certain user interfaces. Value is only considered when larger than the default
Long.MIN_VALUE
is specified for fixed point parameter types. Note that value is not specified for unconstrainedint
parameters.- Returns:
- Minimal
long
value accepted
- Default:
- -9223372036854775808L
-
maxLong
long maxLongMaximal long value accepted (inclusive).This is an optional parameter used as a hint for certain user interfaces. Value is only considered when smaller than the default
Long.MAX_VALUE
is specified for fixed point parameter types. Note that value is not specified for unconstrainedint
parameters.- Returns:
- Maximal
long
value accepted
- Default:
- 9223372036854775807L
-