com.avaje.ebean
Enum Query.UseIndex

java.lang.Object
  java.lang.Enum<Query.UseIndex>
      com.avaje.ebean.Query.UseIndex

All Implemented Interfaces:

Serializable, Comparable<Query.UseIndex>

Enclosing interface:

Query<T>

public static enum Query.UseIndex
extends Enum<Query.UseIndex>

How this query should use (or not) the Lucene Index if one is defined for the bean type.

Enum Constant Summary

DEFAULT

NO

YES_IDS

YES_OBJECTS

Method Summary

static Query.UseIndex	valueOf(String name) Returns the enum constant of this type with the specified name.
static Query.UseIndex[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO

public static final Query.UseIndex NO

DEFAULT

public static final Query.UseIndex DEFAULT

YES_IDS

public static final Query.UseIndex YES_IDS

YES_OBJECTS

public static final Query.UseIndex YES_OBJECTS

Method Detail

values

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

Returns:

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

valueOf

public static Query.UseIndex 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