ch.jalu.typeresolver.numbers

Enum ValueRangeComparison

java.lang.Object

java.lang.Enum<ValueRangeComparison>

ch.jalu.typeresolver.numbers.ValueRangeComparison

All Implemented Interfaces:

Serializable, Comparable<ValueRangeComparison>

public enum ValueRangeComparison
extends Enum<ValueRangeComparison>

Result of the comparison of a number with a type's value range.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_MAXIMUM The number is larger than the maximum value of the range.
BELOW_MINIMUM The number is smaller than the minimum value of the range.
UNSUPPORTED_NAN The number is NaN (Not-a-Number), which is not supported by the target type.
UNSUPPORTED_NEGATIVE_INFINITY The number is negative infinity, which is not supported by the target type.
UNSUPPORTED_POSITIVE_INFINITY The number is positive infinity, which is not supported by the target type.
WITHIN_RANGE The number is within the value range, i.e.

Method Summary

Modifier and Type	Method and Description
static Optional<ValueRangeComparison>	getErrorForNonFiniteValue(double value) Returns the appropriate "Unsupported" comparison entry if the given double represents a non-finite value from Float or Double.
static Optional<ValueRangeComparison>	getErrorForNonFiniteValue(Number number) Returns the appropriate "Unsupported" comparison entry if the given number represents a non-finite value from Float or Double.
boolean	isTooLarge()
boolean	isTooSmall()
boolean	isUnsupportedInfinity()
boolean	isUnsupportedNonFiniteValue()
static ValueRangeComparison	valueOf(String name) Returns the enum constant of this type with the specified name.
static ValueRangeComparison[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WITHIN_RANGE

public static final ValueRangeComparison WITHIN_RANGE

The number is within the value range, i.e. it can be represented without loss of magnitude.

BELOW_MINIMUM

public static final ValueRangeComparison BELOW_MINIMUM

The number is smaller than the minimum value of the range.

ABOVE_MAXIMUM

public static final ValueRangeComparison ABOVE_MAXIMUM

The number is larger than the maximum value of the range.

UNSUPPORTED_POSITIVE_INFINITY

public static final ValueRangeComparison UNSUPPORTED_POSITIVE_INFINITY

The number is positive infinity, which is not supported by the target type.

UNSUPPORTED_NEGATIVE_INFINITY

public static final ValueRangeComparison UNSUPPORTED_NEGATIVE_INFINITY

The number is negative infinity, which is not supported by the target type.

UNSUPPORTED_NAN

public static final ValueRangeComparison UNSUPPORTED_NAN

The number is NaN (Not-a-Number), which is not supported by the target type.

Method Detail

values

public static ValueRangeComparison[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ValueRangeComparison c : ValueRangeComparison.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ValueRangeComparison valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getErrorForNonFiniteValue

public static Optional<ValueRangeComparison> getErrorForNonFiniteValue(Number number)

Returns the appropriate "Unsupported" comparison entry if the given number represents a non-finite value from Float or Double. Useful when attempting to convert to a type that has no support for non-finite values.

Parameters:

number - the number to process

Returns:

optional with unsupported comparison value if the number is infinity/NaN, when applicable

getErrorForNonFiniteValue

public static Optional<ValueRangeComparison> getErrorForNonFiniteValue(double value)

Returns the appropriate "Unsupported" comparison entry if the given double represents a non-finite value from Float or Double. Useful when attempting to convert to a type that has no support for non-finite values. This method also behaves correctly for float numbers (i.e. float infinity/NaN is implicitly converted to a double infinity/NaN in Java).

Parameters:

value - the number to process

Returns:

optional with unsupported comparison value if the number is infinity/NaN, when applicable

isTooSmall

public boolean isTooSmall()

Returns:

true if this entry is due to a too small finite value, or due to unsupported negative infinity; false otherwise

isTooLarge

public boolean isTooLarge()

Returns:

true if this entry is due to a too large finite value, or due to unsupported positive infinity; false otherwise

isUnsupportedInfinity

public boolean isUnsupportedInfinity()

Returns:

true if this entry is an unsupported infinity error, false otherwise

isUnsupportedNonFiniteValue

public boolean isUnsupportedNonFiniteValue()

Returns:

true if this entry is an error due to an unsupported infinity or NaN value, false otherwise