ch.jalu.typeresolver.numbers

Interface ValueRange<T>

Type Parameters:

T - number type this range describes

All Known Implementing Classes:

StandardValueRange, ValueRangeImpl

public interface ValueRange<T>

Value range of a number type.

Method Summary

Modifier and Type	Method and Description
T	getMaxInOwnType()
@Nullable BigDecimal	getMaxValue()
T	getMinInOwnType()
@Nullable BigDecimal	getMinValue()
boolean	hasInfinityAndNaN() Returns whether the type has values for NaN and infinity, such as Double with Double.POSITIVE_INFINITY.
default boolean	isEqualOrSupersetOf(ValueRange<?> other) Returns whether this value range is equal or larger than the given value range.
default boolean	supportsAllValuesOf(ValueRange<?> other) Specifies whether this range can represent all values of the given value range without loss of magnitude.
boolean	supportsDecimals()

Method Detail

getMinValue

@Nullable
@Nullable BigDecimal getMinValue()

Returns:

the minimum value this type can represent; null if there is no explicit bound

getMaxValue

@Nullable
@Nullable BigDecimal getMaxValue()

Returns:

the maximum value this type can represent; null if there is no explicit bound

getMinInOwnType

@Nullable
T getMinInOwnType()

Returns:

the smallest finite value the type can represent, in the type itself (null if the type has no limit)

getMaxInOwnType

@Nullable
T getMaxInOwnType()

Returns:

the largest finite value the type can represent, in the type itself (null if the type has no limit)

supportsDecimals

boolean supportsDecimals()

Returns:

true if this value can represent decimals, false otherwise

hasInfinityAndNaN

boolean hasInfinityAndNaN()

Returns whether the type has values for NaN and infinity, such as Double with Double.POSITIVE_INFINITY.

Returns:

true if the type can represent infinity and NaN

supportsAllValuesOf

default boolean supportsAllValuesOf(ValueRange<?> other)

Specifies whether this range can represent all values of the given value range without loss of magnitude. Loss of precision is not considered. Support for decimals is ignored by this method as it does not constitute a loss of magnitude. For example, BIG_INTEGER.supportsAllValuesOf(BIG_DECIMAL) returns true.

In contrast to isEqualOrSupersetOf(ch.jalu.typeresolver.numbers.ValueRange<?>), this method specifies whether every possible value of the other range can be represented by this range, including infinity and NaN. Therefore, BIG_INTEGER.getValueRange().supportsAllValuesOf(DOUBLE.getValueRange() evaluates to false (because BigInteger cannot represent infinity or NaN), while comparing the same ranges with isEqualOrSupersetOf(ch.jalu.typeresolver.numbers.ValueRange<?>) evaluates to true.

Developers comparing two number types can use NumberType.supportsAllValuesOf(NumberType) as a shortcut to this method.

Parameters:

other - the number type to check

Returns:

true if all values of the given number type can be represented by this type, false otherwise

isEqualOrSupersetOf

default boolean isEqualOrSupersetOf(ValueRange<?> other)

Returns whether this value range is equal or larger than the given value range. In other words, it returns true only if all values in the other range fit into this range. The comparison is based on the minimum and maximum values of the ranges. The presence or absence of decimals or the ability to represent special values like Double.NaN is not taken into account.

Use supportsAllValuesOf(ch.jalu.typeresolver.numbers.ValueRange<?>) if you want to specifically check that every value (such as NaN) of a type can be represented.

Parameters:

other - the other range to compare with

Returns:

true if this.minValue <= other.minValue and this.maxValue >= other.maxValue