com.amazon.carbonado.info
Enum Direction

java.lang.Object
  java.lang.Enum<Direction>
      com.amazon.carbonado.info.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>

public enum Direction
extends Enum<Direction>

Describes a property sorting direction.

Author:

Brian S O'Neill

Enum Constant Summary

ASCENDING

DESCENDING

UNSPECIFIED

Method Summary

static Direction	fromCharacter(char c) Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything else.
Direction	reverse() Returns the reverse direction of this.
char	toCharacter() Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

ASCENDING

public static final Direction ASCENDING

DESCENDING

public static final Direction DESCENDING

UNSPECIFIED

public static final Direction UNSPECIFIED

Method Detail

values

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

Returns:

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

valueOf

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

reverse

public Direction reverse()

Returns the reverse direction of this.

toCharacter

public char toCharacter()

Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.

fromCharacter

public static Direction fromCharacter(char c)

Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything else.