nl.liacs.timeseries.gui

Enum Range

java.lang.Object

java.lang.Enum<Range>

nl.liacs.timeseries.gui.Range

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Range>

public enum Range
extends java.lang.Enum<Range>

Every Range defines a numeric range. The isValid(String) method returns true if the supplied value is of the correct number type, and lies within the defined range, it returns false otherwise.

Note that for floating point numbers, the values NaN and +/-Infinity will always return false. That is, values must be real.

Since the different Ranges define ranges for various number types, the getMinimum() and getMaximum() methods return instances of the generic Number type. The caller is responsible for casting, if needed.

Author:

Marvin Meeng Last updated 11.07.2012

See Also:

RangeVerifier

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOAT 32-bit floating point numbers in the range [-Float.MAX_VALUE, Float.MAX_VALUE].
FLOAT_0_OR_POSITIVE 32-bit floating point numbers in the range [0, Float.MAX_VALUE].
FLOAT_0in_TO_1ex 0 inclusive, 1 exclusive, [0, 1) .
FLOAT_0in_TO_1in 0 inclusive, 1 inclusive, [0, 1] .
FLOAT_POSITIVE 32-bit floating point numbers in the range [Float.MIN_VALUE, Float.MAX_VALUE].
INT Integers in the range [Integer.MIN_VALUE, Integer.MAX_VALUE].
INT_0_OR_POSITIVE Odd and even integers in the range [0, Integer.MAX_VALUE].
INT_0_OR_POSITIVE_EVEN Even integers in the range [0, Integer.MAX_VALUE].
INT_0_OR_POSITIVE_ODD Odd integers in the range [0, Integer.MAX_VALUE].
INT_POSITIVE Integers in the range [1, Integer.MAX_VALUE].
INT_POSITIVE_EVEN Even integers in the range [1, Integer.MAX_VALUE].
INT_POSITIVE_ODD Odd integers in the range [1, Integer.MAX_VALUE].
VALID_GAUSSIAN_ORDER Integers 0, 1 and 2.

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.Number	getMaximum() Return the maximum for the Range.
abstract java.lang.Number	getMinimum() Return the maximum for the Range.
abstract boolean	isValid(java.lang.String theInput) Parses the String supplied as parameter, and indicates whether the supplied value lies within the defined range.
static Range	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Range[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INT_0_OR_POSITIVE

public static final Range INT_0_OR_POSITIVE

Odd and even integers in the range [0, Integer.MAX_VALUE].

INT_0_OR_POSITIVE_ODD

public static final Range INT_0_OR_POSITIVE_ODD

Odd integers in the range [0, Integer.MAX_VALUE].

INT_0_OR_POSITIVE_EVEN

public static final Range INT_0_OR_POSITIVE_EVEN

Even integers in the range [0, Integer.MAX_VALUE].

INT_POSITIVE

public static final Range INT_POSITIVE

Integers in the range [1, Integer.MAX_VALUE].

INT_POSITIVE_ODD

public static final Range INT_POSITIVE_ODD

Odd integers in the range [1, Integer.MAX_VALUE].

INT_POSITIVE_EVEN

public static final Range INT_POSITIVE_EVEN

Even integers in the range [1, Integer.MAX_VALUE].

INT

public static final Range INT

Integers in the range [Integer.MIN_VALUE, Integer.MAX_VALUE].

FLOAT_0_OR_POSITIVE

public static final Range FLOAT_0_OR_POSITIVE

32-bit floating point numbers in the range [0, Float.MAX_VALUE].

FLOAT_0in_TO_1ex

public static final Range FLOAT_0in_TO_1ex

0 inclusive, 1 exclusive, [0, 1) .

FLOAT_0in_TO_1in

public static final Range FLOAT_0in_TO_1in

0 inclusive, 1 inclusive, [0, 1] .

FLOAT_POSITIVE

public static final Range FLOAT_POSITIVE

32-bit floating point numbers in the range [Float.MIN_VALUE, Float.MAX_VALUE].

FLOAT

public static final Range FLOAT

32-bit floating point numbers in the range [-Float.MAX_VALUE, Float.MAX_VALUE].

VALID_GAUSSIAN_ORDER

public static final Range VALID_GAUSSIAN_ORDER

Integers 0, 1 and 2.

Method Detail

values

public static Range[] 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 (Range c : Range.values())
    System.out.println(c);

Returns:

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

valueOf

public static Range valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getMinimum

public abstract java.lang.Number getMinimum()

Return the maximum for the Range.

Note, the caller is responsible for any casting, if needed.

Returns:

The minimum.

getMaximum

public abstract java.lang.Number getMaximum()

Return the maximum for the Range.

Note, the caller is responsible for any casting, if needed.

Returns:

The maximum.

isValid

public abstract boolean isValid(java.lang.String theInput)

Parses the String supplied as parameter, and indicates whether the supplied value lies within the defined range. This method always returns false when a parsing error occurs. Also, for floating point numbers, this method always returns false for the values NaN and +/-Infinity, as they are considered invalid.

Parameters:

theInput - A Sting representation of the number to test.

Returns:

true if the parameter is successfully parsed as the defined number type, and lies within the defined range, false otherwise.