fj

Enum Ordering

java.lang.Object

java.lang.Enum<Ordering>

fj.Ordering

All Implemented Interfaces:

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

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

The comparison of two instances of a type may have one of three orderings; less than, equal or greater than.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQ Equal.
GT Greater than.
LT Less than.

Method Summary

Methods

Modifier and Type	Method and Description
static Ordering	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Ordering[]	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

LT

public static final Ordering LT

Less than.

EQ

public static final Ordering EQ

Equal.

GT

public static final Ordering GT

Greater than.

Method Detail

values

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

Returns:

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

valueOf

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