org.geotoolkit.lang
Annotation Type ValueRange

@Documented
@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface ValueRange

The range of values that a method can return. This is used mostly for metadata objects performing runtime checks.

Since:

3.04

Version:

3.04

Author:

Martin Desruisseaux (Geomatys)

Module:

utility/geotk-utility (download)

View source code for this class

Optional Element Summary

boolean	isMaxIncluded true if the maximal value is inclusive, or false if it is exclusive.
boolean	isMinIncluded true if the minimal value is inclusive, or false if it is exclusive.
double	maximum Returns the maximal value that a method can return.
double	minimum Returns the minimal value that a method can return.

minimum

public abstract double minimum

Returns the minimal value that a method can return. The default value is negative infinity, which means that there is no minimal value.

Returns:

The minimal value.

Default:

-1d/0d

maximum

public abstract double maximum

Returns the maximal value that a method can return. The default value is positive infinity, which means that there is no maximal value.

Returns:

The maximal value.

Default:

1d/0d

isMinIncluded

public abstract boolean isMinIncluded

true if the minimal value is inclusive, or false if it is exclusive. By default the minimum value is inclusive.

Returns:

true if the minimum value is inclusive.

Default:

true

isMaxIncluded

public abstract boolean isMaxIncluded

true if the maximal value is inclusive, or false if it is exclusive. By default the maximum value is inclusive.

Returns:

true if the maximum value is inclusive.

Default:

true