Package org.elasticsearch.search.fetch.subphase.highlight

Enum Class HighlightBuilder.BoundaryScannerType

java.lang.Object

java.lang.Enum<HighlightBuilder.BoundaryScannerType>

org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.BoundaryScannerType

All Implemented Interfaces:

Serializable, Comparable<HighlightBuilder.BoundaryScannerType>, Constable, Writeable

Enclosing class:

HighlightBuilder

public static enum HighlightBuilder.BoundaryScannerType
extends Enum<HighlightBuilder.BoundaryScannerType>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHARS
SENTENCE
WORD

Method Summary

Modifier and Type	Method	Description
static HighlightBuilder.BoundaryScannerType	fromString(String boundaryScannerType)
static HighlightBuilder.BoundaryScannerType	readFromStream(StreamInput in)
String	toString()
static HighlightBuilder.BoundaryScannerType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HighlightBuilder.BoundaryScannerType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHARS

public static final HighlightBuilder.BoundaryScannerType CHARS

WORD

public static final HighlightBuilder.BoundaryScannerType WORD

SENTENCE

public static final HighlightBuilder.BoundaryScannerType SENTENCE

Method Details

values

public static HighlightBuilder.BoundaryScannerType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HighlightBuilder.BoundaryScannerType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

readFromStream

public static HighlightBuilder.BoundaryScannerType readFromStream(StreamInput in)
                                                           throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

fromString

public static HighlightBuilder.BoundaryScannerType fromString(String boundaryScannerType)

toString

public String toString()

Overrides:

toString in class Enum<HighlightBuilder.BoundaryScannerType>