com.ur.urcap.api.domain.value

Interface Range<T>

Type Parameters:

T - The type of value for this range, e.g. a simple value type, like Length.

public interface Range<T>

This interface represents (describes) an inclusive range (or "interval") of numeric values of the same type defined by a minimum and maximum value. The value type for the range can, for instance, be a simple value type, such as Length and Mass.

A range is defined to contain all the values between the minimum value (see getLowerBound()) and the maximum value (see getUpperBound()), where the minimum/maximum value (or lower bound/upper bound) are included in the range.

The range can be used to describe/define the limits or requirements for a parameter, e.g. "lengths must be between 0.0 mm and 5000.0 mm inclusive" (i.e., 0.0 mm <= l <= 5000.0 mm).

Since:

1.13.0

Method Summary

Modifier and Type	Method and Description
T	getLowerBound()
T	getUpperBound()
boolean	isWithinRange(T value) This method will evaluate if the specified value is within the bounds of the range, bounds inclusive.

Method Detail

getLowerBound

T getLowerBound()

Returns:

The minimum value (lower endpoint) for this range

getUpperBound

T getUpperBound()

Returns:

The maximum value (upper endpoint) for this range

isWithinRange

boolean isWithinRange(T value)

This method will evaluate if the specified value is within the bounds of the range, bounds inclusive.

A value is considered to be within the range, if minimum <= value <= maximum, where minimum and maximum are the lower endpoint and the upper endpoint of the range, respectively.

Parameters:

value - The value to evaluate

Returns:

true, if the value is within the range (bounds inclusive), false otherwise.