com.mware.ge.values

Enum Comparison

java.lang.Object

java.lang.Enum<Comparison>

com.mware.ge.values.Comparison

All Implemented Interfaces:

Serializable, Comparable<Comparison>

public enum Comparison
extends Enum<Comparison>

Defines the result of a ternary comparison.

In a ternary comparison the result may not only be greater than, equal or smaller than but the result can also be undefined.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUAL
GREATER_THAN
GREATER_THAN_AND_EQUAL
SMALLER_THAN
SMALLER_THAN_AND_EQUAL
UNDEFINED

Method Summary

Modifier and Type	Method and Description
static Comparison	from(int i) Maps an integer value to comparison result.
int	value() Integer representation of comparison
static Comparison	valueOf(String name) Returns the enum constant of this type with the specified name.
static Comparison[]	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

GREATER_THAN

public static final Comparison GREATER_THAN

EQUAL

public static final Comparison EQUAL

SMALLER_THAN

public static final Comparison SMALLER_THAN

GREATER_THAN_AND_EQUAL

public static final Comparison GREATER_THAN_AND_EQUAL

SMALLER_THAN_AND_EQUAL

public static final Comparison SMALLER_THAN_AND_EQUAL

UNDEFINED

public static final Comparison UNDEFINED

Method Detail

values

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

Returns:

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

valueOf

public static Comparison 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

value

public int value()

Integer representation of comparison

Returns a positive integer if GREATER_THAN than, negative integer for SMALLER_THAN, and zero for EQUAL

Returns:

a positive number if result is greater than, a negative number if the result is smaller than or zero if equal.

Throws:

IllegalStateException - if the result is undefined.

from

public static Comparison from(int i)

Maps an integer value to comparison result.

Parameters:

i - the integer to be mapped to a Comparison

Returns:

GREATER_THAN than if positive, SMALLER_THAN if negative or EQUAL if zero