org.apache.hadoop.hbase.util
Enum Order

java.lang.Object
  java.lang.Enum<Order>
      org.apache.hadoop.hbase.util.Order

All Implemented Interfaces:

Serializable, Comparable<Order>

@InterfaceAudience.Public
@InterfaceStability.Evolving
public enum Order
extends Enum<Order>

Used to describe or modify the lexicographical sort order of a byte[]. Default ordering is considered ASCENDING. The order of a byte[] can be inverted, resulting in DESCENDING order, by replacing each byte with its 1's compliment.

Enum Constant Summary

ASCENDING

DESCENDING

Method Summary

abstract byte	apply(byte val) Apply order to the byte val.
abstract void	apply(byte[] val) Apply order to the byte array val.
abstract void	apply(byte[] val, int offset, int length) Apply order to a range within the byte array val.
abstract int	cmp(int cmp) Returns the adjusted trichotomous value according to the ordering imposed by this Order.
static Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static Order[]	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 Order ASCENDING

DESCENDING

public static final Order DESCENDING

Method Detail

values

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

Returns:

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

valueOf

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

cmp

public abstract int cmp(int cmp)

Returns the adjusted trichotomous value according to the ordering imposed by this Order.

apply

public abstract byte apply(byte val)

Apply order to the byte val.

apply

public abstract void apply(byte[] val)

Apply order to the byte array val.

apply

public abstract void apply(byte[] val,
                           int offset,
                           int length)

Apply order to a range within the byte array val.