org.infinispan.query.dsl

Enum IndexedQueryMode

java.lang.Object

java.lang.Enum<IndexedQueryMode>

org.infinispan.query.dsl.IndexedQueryMode

All Implemented Interfaces:

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

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

Defines the execution mode of an indexed query.

Since:

9.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROADCAST Query is sent to all nodes, and results are combined before returning to the caller.
FETCH Query is executed locally in the caller.

Method Summary

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

BROADCAST

public static final IndexedQueryMode BROADCAST

Query is sent to all nodes, and results are combined before returning to the caller. This allows each node to have its own index, and the query will return the cluster wide results.

FETCH

public static final IndexedQueryMode FETCH

Query is executed locally in the caller. The whole index must be available in order to return full results, otherwise only results available at the caller's local index are returned.

Method Detail

values

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

Returns:

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

valueOf

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