org.apache.lucene.codecs.lucene40.values

Enum Bytes.Mode

java.lang.Object

java.lang.Enum<Bytes.Mode>

org.apache.lucene.codecs.lucene40.values.Bytes.Mode

All Implemented Interfaces:

Serializable, Comparable<Bytes.Mode>

Enclosing class:

Bytes

public static enum Bytes.Mode
extends Enum<Bytes.Mode>

Defines the Writers store mode. The writer will either store the bytes sequentially (STRAIGHT, dereferenced (DEREF) or sorted (SORTED)

WARNING: This API is experimental and might change in incompatible ways in the next release.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEREF Mode for dereferenced stored bytes
SORTED Mode for sorted stored bytes
STRAIGHT Mode for sequentially stored bytes

Method Summary

Methods

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

STRAIGHT

public static final Bytes.Mode STRAIGHT

Mode for sequentially stored bytes

DEREF

public static final Bytes.Mode DEREF

Mode for dereferenced stored bytes

SORTED

public static final Bytes.Mode SORTED

Mode for sorted stored bytes

Method Detail

values

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

Returns:

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

valueOf

public static Bytes.Mode 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