Package tech.units.indriya.spi

Interface Range<T>

Type Parameters:

T - The value of the range.

All Superinterfaces:

tech.uom.lib.common.function.MaximumSupplier<T>, tech.uom.lib.common.function.MinimumSupplier<T>

All Known Implementing Classes:

QuantityRange

public interface Range<T>
extends tech.uom.lib.common.function.MinimumSupplier<T>, tech.uom.lib.common.function.MaximumSupplier<T>

A Range is a pair of T items that represent a range of values.

API Note:

This interface places no restrictions on the mutability of implementations, however immutability is strongly recommended. All implementations should be Comparable.

Since:

1.0

Version:

2.0, August 23, 2023

Author:

Werner Keil

See Also:

Wikipedia: Range

Method Summary

Modifier and Type	Method	Description
boolean	contains(T t)	Checks whether the given T is within this range
T	getMaximum()	Returns the largest value of the range.
T	getMinimum()	Returns the smallest value of the range.
T	getResolution()	Returns the resolution of the range.
boolean	hasMaximum()	Method to easily check if getMaximum() is not null.
boolean	hasMinimum()	Method to easily check if getMinimum() is not null.

Method Detail

getMinimum

T getMinimum()

Returns the smallest value of the range. The value is the same as that given as the constructor parameter for the smallest value.

Specified by:

getMinimum in interface tech.uom.lib.common.function.MinimumSupplier<T>

Returns:

the minimum value

getMaximum

T getMaximum()

Returns the largest value of the range. The value is the same as that given as the constructor parameter for the largest value.

Specified by:

getMaximum in interface tech.uom.lib.common.function.MaximumSupplier<T>

Returns:

the maximum value

getResolution

T getResolution()

Returns the resolution of the range. The value is the same as that given as the constructor parameter for the largest value.

Returns:

resolution of the range, the value is the same as that given as the constructor parameter for the resolution

hasMinimum

boolean hasMinimum()

Method to easily check if getMinimum() is not null.

Returns:

true if getMinimum() is not null .

hasMaximum

boolean hasMaximum()

Method to easily check if getMaximum() is not null.

Returns:

true if getMaximum() is not null.

contains

boolean contains(T t)

Checks whether the given T is within this range

Parameters:

t -

Returns:

true if the value is within the range