org.springframework.cassandra.core

Enum Ordering

java.lang.Object

java.lang.Enum<Ordering>

org.springframework.cassandra.core.Ordering

All Implemented Interfaces:

Serializable, Comparable<Ordering>, Comparator<Ordering>

public enum Ordering
extends Enum<Ordering>
implements Comparator<Ordering>

Enum for Cassandra primary key column ordering. Implements Comparator in that ASCENDING is ordered before DESCENDING.

Author:

Matthew T. Adams

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Ascending Cassandra column ordering.
DESCENDING Descending Cassandra column ordering.

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(Ordering l, Ordering r)
String	cql() Returns the CQL keyword of this Ordering.
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

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Enum Constant Detail

ASCENDING

public static final Ordering ASCENDING

Ascending Cassandra column ordering.

DESCENDING

public static final Ordering DESCENDING

Descending Cassandra column ordering.

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

cql

public String cql()

Returns the CQL keyword of this Ordering.

compare

public int compare(Ordering l,
          Ordering r)

Specified by:

compare in interface Comparator<Ordering>