org.vertexium.search

Enum IndexHint

java.lang.Object

java.lang.Enum<IndexHint>

org.vertexium.search.IndexHint

All Implemented Interfaces:

Serializable, Comparable<IndexHint>

public enum IndexHint
extends Enum<IndexHint>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOT_INDEX Do not index the element in the search index.
INDEX Index the element in the search index.

Method Summary

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

INDEX

public static final IndexHint INDEX

Index the element in the search index.

DO_NOT_INDEX

public static final IndexHint DO_NOT_INDEX

Do not index the element in the search index.

Method Detail

values

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

Returns:

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

valueOf

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