Package org.apache.lucene.analysis.ngram

Enum Lucene43EdgeNGramTokenizer.Side

java.lang.Object

java.lang.Enum<Lucene43EdgeNGramTokenizer.Side>

org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer.Side

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Lucene43EdgeNGramTokenizer.Side>

Enclosing class:

Lucene43EdgeNGramTokenizer

public static enum Lucene43EdgeNGramTokenizer.Side
extends java.lang.Enum<Lucene43EdgeNGramTokenizer.Side>

Specifies which side of the input the n-gram should be generated from

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACK	Get the n-gram from the end of the input
FRONT	Get the n-gram from the front of the input

Method Summary

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

FRONT

public static final Lucene43EdgeNGramTokenizer.Side FRONT

Get the n-gram from the front of the input

BACK

public static final Lucene43EdgeNGramTokenizer.Side BACK

Get the n-gram from the end of the input

Method Detail

values

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

Returns:

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

valueOf

public static Lucene43EdgeNGramTokenizer.Side 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

getLabel

public abstract java.lang.String getLabel()

getSide

public static Lucene43EdgeNGramTokenizer.Side getSide(java.lang.String sideName)