StandardValueRange (JavaTypeResolver 0.1.0 API)

java.lang.Object
- java.lang.Enum<StandardValueRange>
- - ch.jalu.typeresolver.numbers.StandardValueRange

All Implemented Interfaces:

ValueRange, Serializable, Comparable<StandardValueRange>
```
public enum StandardValueRange
extends Enum<StandardValueRange>
implements ValueRange
```
Provides value ranges of the standard Java number types: byte, short, integer, long, float, double, BigInteger and BigDecimal. Used by StandardNumberType.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BIG_DECIMAL` Big decimal: supports decimals and has a theoretically infinite range of supported values.
`BIG_INTEGER` Big integer: integer with a theoretically infinite range of supported values.
`BYTE` Byte: [-128, 127].
`DOUBLE` Double: [-1.7976931348623157E308, 1.7976931348623157E308].
`FLOAT` Float: [-3.4028235E38, 3.4028235E38].
`INTEGER` Integer: [-2147483648, 2147483647].
`LONG` Long: [-9223372036854775808, 9223372036854775807].
`SHORT` Short: [-32768, 32767].

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StandardValueRange`	`findRangeOrThrow(Number number)` Returns the value range for the type of the given number.
`@Nullable Number`	`getMaxInOwnType()`
`@Nullable BigDecimal`	`getMaxValue()`
`@Nullable Number`	`getMinInOwnType()`
`@Nullable BigDecimal`	`getMinValue()`
`boolean`	`hasInfinityAndNaN()` Returns whether the type has values for `NaN` and infinity, such as Double with `Double.POSITIVE_INFINITY`.
`boolean`	`supportsAllValuesOf(StandardValueRange other)` Returns whether this range supports all values of the given range.
`boolean`	`supportsDecimals()`
`String`	`toString()`
`static StandardValueRange`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StandardValueRange[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.jalu.typeresolver.numbers.ValueRange
isEqualOrSupersetOf, supportsAllValuesOf

- Enum Constant Detail
  - BYTE
```
public static final StandardValueRange BYTE
```
    Byte: [-128, 127].
  - SHORT
```
public static final StandardValueRange SHORT
```
    Short: [-32768, 32767].
  - INTEGER
```
public static final StandardValueRange INTEGER
```
    Integer: [-2147483648, 2147483647].
  - LONG
```
public static final StandardValueRange LONG
```
    Long: [-9223372036854775808, 9223372036854775807].
  - FLOAT
```
public static final StandardValueRange FLOAT
```
    Float: [-3.4028235E38, 3.4028235E38].
  - DOUBLE
```
public static final StandardValueRange DOUBLE
```
    Double: [-1.7976931348623157E308, 1.7976931348623157E308].
  - BIG_INTEGER
```
public static final StandardValueRange BIG_INTEGER
```
    Big integer: integer with a theoretically infinite range of supported values.
  - BIG_DECIMAL
```
public static final StandardValueRange BIG_DECIMAL
```
    Big decimal: supports decimals and has a theoretically infinite range of supported values.
- Method Detail
  - values
```
public static StandardValueRange[] 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 (StandardValueRange c : StandardValueRange.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StandardValueRange 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
  - findRangeOrThrow
```
public static StandardValueRange findRangeOrThrow(Number number)
```
    Returns the value range for the type of the given number. This method supports all numbers that can be assigned to an instantiable Number class in the JDK, such as Integer, Byte and BigDecimal. If the number type is unknown, an IllegalArgumentException is thrown.
    The returned range should not be used to derive the given number's class, as multiple types can map to the same value range. For example:
```
   StandardValueRange range1 = detectRangeOrThrow(1L);                  // Result: LONG
   StandardValueRange range2 = detectRangeOrThrow(new AtomicLong(2));   // Result: LONG
   StandardValueRange range3 = detectRangeOrThrow(new LongAdder());     // Result: LONG

   BigDecimal bigDecimalExtension = new BigDecimal("4") { };            // anonymous extension
   StandardValueRange range4 = detectRangeOrThrow(bigDecimalExtension); // Result: BIG_DECIMAL
 
```
    Use StandardNumberType.fromNumberClass(java.lang.Class<T>) if you want to match the number strictly by its type.
    Parameters:
    
    number - the number to determine the value range for
    
    Returns:
    
    the enum entry corresponding to the number's value range
  - supportsDecimals
```
public boolean supportsDecimals()
```
    Specified by:
    
    supportsDecimals in interface ValueRange
    
    Returns:
    
    true if this value can represent decimals, false otherwise
  - hasInfinityAndNaN
```
public boolean hasInfinityAndNaN()
```
    Description copied from interface: ValueRange
    
    Returns whether the type has values for NaN and infinity, such as Double with Double.POSITIVE_INFINITY.
    
    Specified by:
    
    hasInfinityAndNaN in interface ValueRange
    
    Returns:
    
    true if the type can represent infinity and NaN
  - supportsAllValuesOf
```
public boolean supportsAllValuesOf(StandardValueRange other)
```
    Returns whether this range supports all values of the given range. See ValueRange.supportsAllValuesOf(ch.jalu.typeresolver.numbers.ValueRange<?>) for details. This method exists as a convenience to avoid unchecked warnings when comparing two StandardValueRange objects.
    
    Parameters:
    
    other - the range to check with
    
    Returns:
    
    true if all values of the given number type can be represented by this type, false otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<StandardValueRange>
  - getMinValue
```
@Nullable
public @Nullable BigDecimal getMinValue()
```
    Specified by:
    
    getMinValue in interface ValueRange
    
    Returns:
    
    the minimum value this type can represent; null if there is no explicit bound
  - getMaxValue
```
@Nullable
public @Nullable BigDecimal getMaxValue()
```
    Specified by:
    
    getMaxValue in interface ValueRange
    
    Returns:
    
    the maximum value this type can represent; null if there is no explicit bound
  - getMinInOwnType
```
@Nullable
public @Nullable Number getMinInOwnType()
```
    Specified by:
    
    getMinInOwnType in interface ValueRange
    
    Returns:
    
    the smallest finite value the type can represent, in the type itself (null if the type has no limit)
  - getMaxInOwnType
```
@Nullable
public @Nullable Number getMaxInOwnType()
```
    Specified by:
    
    getMaxInOwnType in interface ValueRange
    
    Returns:
    
    the largest finite value the type can represent, in the type itself (null if the type has no limit)

Enum StandardValueRange

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface ch.jalu.typeresolver.numbers.ValueRange

Enum Constant Detail

BYTE

SHORT

INTEGER

LONG

FLOAT

DOUBLE

BIG_INTEGER

BIG_DECIMAL

Method Detail

values

valueOf

findRangeOrThrow

supportsDecimals

hasInfinityAndNaN

supportsAllValuesOf

toString

getMinValue

getMaxValue

getMinInOwnType

getMaxInOwnType