com.amazon.carbonado.qe

Enum QueryHint

java.lang.Object

java.lang.Enum<QueryHint>

com.amazon.carbonado.qe.QueryHint

All Implemented Interfaces:

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

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

Defines a hint key.

Since:

1.2

Author:

Brian S O'Neill

See Also:

QueryHints

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSUME_SLICE Intention to consume a slice of matched records

Method Summary

Methods

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

CONSUME_SLICE

public static final QueryHint CONSUME_SLICE

Intention to consume a slice of matched records

Method Detail

values

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

Returns:

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

valueOf

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