net.sf.mmm.util.value.api

Class Range<V>

java.lang.Object

net.sf.mmm.util.value.api.Range<V>

Type Parameters:

V - is the generic type of the contained values.

All Implemented Interfaces:

Serializable, AttributeReadMaximumValue<V>, AttributeReadMinimumValue<V>

Direct Known Subclasses:

NumberRange

public class Range<V>
extends Object
implements Serializable, AttributeReadMinimumValue<V>, AttributeReadMaximumValue<V>

This class represents a range of two values, minimum and maximum. Validation is performed at construction so a given Range should always be valid (unless created via reflection or de-serialization).
ATTENTION:
Since version 4.0.0 the minimum and maximum value 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:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private V	max
static String	MAX_UNBOUND The unbound maximum.
private V	min
static String	MIN_UNBOUND The unbound minimum.
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Range() The constructor for serialization.
	Range(V min, V max) The constructor.

Method Summary

Modifier and Type	Method and Description
protected Comparator<? super V>	getComparator()
V	getMax() Shorthand form for getMaximumValue().
V	getMaximumValue() This method gets the maximum value of this object.
V	getMin() Shorthand form for getMinimumValue().
V	getMinimumValue() This method gets the minimum value of this object.
boolean	isContained(V value) This method determines if the given value is within this Range from minimum to maximum.
String	toString()
void	verifyContained(V value) This method verifies that the given value is contained in this range .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

min

private V min

max

private V max

MIN_UNBOUND

public static final String MIN_UNBOUND

The unbound minimum.

See Also:

Constant Field Values

MAX_UNBOUND

public static final String MAX_UNBOUND

The unbound maximum.

See Also:

Constant Field Values

Constructor Detail

Range

protected Range()

The constructor for serialization.

Range

public Range(V min,
             V max)

The constructor.

Parameters:

min - - see getMin(). To create an open range use the minimum value.

max - - see getMax(). To create an open range use the maximum value.

Method Detail

getMin

public V getMin()

Shorthand form for getMinimumValue().

Returns:

the lower bound of this range. Must NOT be null and NOT be less than max.

getMax

public V getMax()

Shorthand form for getMaximumValue().

Returns:

the upper bound of this range. Must NOT be null and NOT be greater than min.

getMinimumValue

public V getMinimumValue()

This method gets the minimum value of this object. A legal value has to be greater or equal to this minimum.

Specified by:

getMinimumValue in interface AttributeReadMinimumValue<V>

Returns:

the minimum allowed for value or null if unbounded.

Since:

4.0.0

See Also:

getMin()

getMaximumValue

public V getMaximumValue()

This method gets the maximum value of this object. A legal value has to be less or equal to this maximum.

Specified by:

getMaximumValue in interface AttributeReadMaximumValue<V>

Returns:

the maximum allowed for value or null if unbounded.

Since:

4.0.0

See Also:

getMax()

getComparator

protected 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 create a sub-class of Range and override this method.

isContained

public boolean isContained(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).

verifyContained

public void verifyContained(V value)
                     throws ValueOutOfRangeException

This method verifies that the given value is contained in this range .

Parameters:

value - is the value to check.

Throws:

ValueOutOfRangeException - if not contained.

ValueOutOfRangeException

toString

public String toString()

Overrides:

toString in class Object