org.spongepowered.api.data.value

Interface BoundedValue<E>

Type Parameters:

E - The type of value that can be compared

All Superinterfaces:

BaseValue<E>

All Known Subinterfaces:

ImmutableBoundedValue<E>, MutableBoundedValue<E>

public interface BoundedValue<E>
extends BaseValue<E>

Represents a value that may itself be Comparable or can be compared using the Comparator such that the value is "bounded" by a getMinValue() and a getMaxValue(). For a majority of values, a BoundedValue is limited to being within it's destined bounds. Any BoundedValue that is out of it's intended bounds will throw an IllegalStateException if used or offered to a ValueContainer or DataHolder.

Method Summary

Modifier and Type	Method and Description
Comparator<E>	getComparator() The comparator used to compare a value of the proper type.
E	getMaxValue() Gets the required "maximum" value such that the value is only valid if the following is true:
E	getMinValue() Gets the required "minimum" value such that the value is only valid if the following is true:

Methods inherited from interface org.spongepowered.api.data.value.BaseValue

exists, get, getDefault, getDirect, getKey

Method Detail

getMinValue

E getMinValue()

Gets the required "minimum" value such that the value is only valid if the following is true:

 if (getComparator().compare(getValue(), getMinValue()) >= 0)
 

.

Returns:

The supposed minimum value

getMaxValue

E getMaxValue()

Gets the required "maximum" value such that the value is only valid if the following is true:

 if (getComparator().compare(getValue(), getMaxValue()) <= 0)
 

.

Returns:

The supposed maximum value

getComparator

Comparator<E> getComparator()

The comparator used to compare a value of the proper type. Can be used for validation with the getMinValue() and getMaxValue().

Returns:

The comparator used for this value