com.hazelcast.query.impl

Enum QueryContext.IndexMatchHint

java.lang.Object

java.lang.Enum<QueryContext.IndexMatchHint>

com.hazelcast.query.impl.QueryContext.IndexMatchHint

All Implemented Interfaces:

Serializable, Comparable<QueryContext.IndexMatchHint>

Enclosing class:

QueryContext

public static enum QueryContext.IndexMatchHint
extends Enum<QueryContext.IndexMatchHint>

Defines possible index matching hints.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXACT_NAME Match pattern is interpreted as a full index name and may specify a composite index name.
NONE Match pattern is interpreted as an attribute name.
PREFER_ORDERED Match pattern interpreted is as an attribute name.
PREFER_UNORDERED Match pattern is interpreted as an attribute name.

Method Summary

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

NONE

public static final QueryContext.IndexMatchHint NONE

Match pattern is interpreted as an attribute name. An index is matched without any preferences of ordered indexes over unordered ones and vice versa.

PREFER_UNORDERED

public static final QueryContext.IndexMatchHint PREFER_UNORDERED

Match pattern is interpreted as an attribute name. An index is matched with a preference of unordered indexes over ordered ones.

PREFER_ORDERED

public static final QueryContext.IndexMatchHint PREFER_ORDERED

Match pattern interpreted is as an attribute name. An index is matched with a preference of ordered indexes over unordered ones.

EXACT_NAME

public static final QueryContext.IndexMatchHint EXACT_NAME

Match pattern is interpreted as a full index name and may specify a composite index name.

Method Detail

values

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

Returns:

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

valueOf

public static QueryContext.IndexMatchHint 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