Type Parameters:

V - type of the contained values.

All Known Subinterfaces:

WritableRange<V>

All Known Implementing Classes:

AbstractRange, NumberRangeType, NumericRange, RangeType
```
public interface Range<V>
```
This class represents a range from minimum to maximum. Implementations shall validate at construction so a given Range should always be valid.
ATTENTION:
The minimum and maximum may be null for unbounded ranges. It is still recommended to use fixed bounds such as Long.MAX_VALUE. However, for types such as BigDecimal this is not possible.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`BOUND_END_EXCLUSIVE`	Char indicating end with exclusive maximum.
`static char`	`BOUND_END_INCLUSIVE`	Char indicating end with inclusive maximum.
`static char`	`BOUND_SEPARATOR`	Char to separate minimum and maximum.
`static char`	`BOUND_START_EXCLUSIVE`	Char indicating start with exclusive minimum.
`static char`	`BOUND_START_INCLUSIVE`	Char indicating start with inclusive minimum.
`static String`	`MAX_UNBOUND`	The unbound maximum.
`static String`	`MIN_UNBOUND`	The unbound minimum.
`static String`	`PROPERTY_MAX`	Property name of `getMax()`.
`static String`	`PROPERTY_MIN`	Property name of `getMin()`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default V`	`clip(V value)`	This method clips the given `value` so the result is `contained` in this `Range` unless the given `value` is `null`.
`default boolean`	`contains(V value)`	This method determines if the given `value` is within this `Range` from `minimum` to `maximum`.
`default Comparator<? super V>`	`getComparator()`
`V`	`getMax()`
`V`	`getMin()`
`static <T> Range<T>`	`unbounded()`

- Field Detail
  - BOUND_START_INCLUSIVE
```
static final char BOUND_START_INCLUSIVE
```
    Char indicating start with inclusive minimum.
    
    See Also:
    
    Constant Field Values
  - BOUND_START_EXCLUSIVE
```
static final char BOUND_START_EXCLUSIVE
```
    Char indicating start with exclusive minimum.
    
    See Also:
    
    Constant Field Values
  - BOUND_END_INCLUSIVE
```
static final char BOUND_END_INCLUSIVE
```
    Char indicating end with inclusive maximum.
    
    See Also:
    
    Constant Field Values
  - BOUND_END_EXCLUSIVE
```
static final char BOUND_END_EXCLUSIVE
```
    Char indicating end with exclusive maximum.
    
    See Also:
    
    Constant Field Values
  - BOUND_SEPARATOR
```
static final char BOUND_SEPARATOR
```
    Char to separate minimum and maximum. Mathematical convention would be to use a comma (','), but this causes problems when parsing string representations as a comma may also occur in the minimum or maximum value.
    
    See Also:
    
    Constant Field Values
  - MIN_UNBOUND
```
static final String MIN_UNBOUND
```
    The unbound minimum.
    
    See Also:
    
    Constant Field Values
  - MAX_UNBOUND
```
static final String MAX_UNBOUND
```
    The unbound maximum.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MIN
```
static final String PROPERTY_MIN
```
    Property name of getMin().
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MAX
```
static final String PROPERTY_MAX
```
    Property name of getMax().
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMin
```
V getMin()
```
    Returns:
    
    the lower bound of this range or null if no lower bound is defined. Has to be less than max if both boundaries are not null.
  - getMax
```
V getMax()
```
    Returns:
    
    the upper bound of this range or null if no upper bound is defined. Has to be greater than min if both boundaries are not null.
  - getComparator
```
default Comparator<? super V> getComparator()
```
    Returns:
    
    the Comparator used to compare values of this Range. The default implementation assumes that the value type implements Comparable. If you want to use other value types you need to override this method.
  - contains
```
default boolean contains(V value)
```
    This method determines if the given value is within this Range from minimum to maximum.
    
    Parameters:
    
    value - is the vale to check.
    
    Returns:
    
    true if contained (minimum <= value >= maximum), false otherwise. If the given value is null, false will be returned.
  - clip
```
default V clip(V value)
```
    This method clips the given value so the result is contained in this Range unless the given value is null.
    
    Parameters:
    
    value - is the vale to clip. May be null.
    
    Returns:
    
    the given value clipped to this range. If the given value is less than the minimum, that minimum will be returned. If the given value is greater than the maximum, that maximum will be returned. Otherwise the given value is returned.
  - unbounded
```
static <T> Range<T> unbounded()
```
    Type Parameters:
    
    T - type of the contained value.
    
    Returns:
    
    the unbounded Range instance (with getMin() and getMax() being null).

Interface Range<V>

Field Summary

Method Summary

Field Detail

BOUND_START_INCLUSIVE

BOUND_START_EXCLUSIVE

BOUND_END_INCLUSIVE

BOUND_END_EXCLUSIVE

BOUND_SEPARATOR

MIN_UNBOUND

MAX_UNBOUND

PROPERTY_MIN

PROPERTY_MAX

Method Detail

getMin

getMax

getComparator

contains

clip

unbounded