Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg

This software is released under an open source BSD licence.

fj.pre
Enum Ordering

java.lang.Object
  extended by java.lang.Enum<Ordering>
      extended by fj.pre.Ordering
All Implemented Interfaces:
Serializable, Comparable<Ordering>

public enum Ordering
extends 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
EQ
          Equal.
GT
          Greater than.
LT
          Less than.
 
Method Summary
static Ordering valueOf(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(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

Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg

This software is released under an open source BSD licence.