org.elasticsearch.indices.analysis

Enum PreBuiltCharFilters

java.lang.Object

java.lang.Enum<PreBuiltCharFilters>

org.elasticsearch.indices.analysis.PreBuiltCharFilters

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreBuiltCharFilters>

public enum PreBuiltCharFilters
extends java.lang.Enum<PreBuiltCharFilters>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML_STRIP

Field Summary

Fields

Modifier and Type	Field and Description
protected PreBuiltCacheFactory.PreBuiltCache<CharFilterFactory>	cache

Method Summary

Modifier and Type	Method and Description
abstract java.io.Reader	create(java.io.Reader tokenStream, Version version)
CharFilterFactory	getCharFilterFactory(Version version)
static PreBuiltCharFilters	getOrDefault(java.lang.String name, PreBuiltCharFilters defaultCharFilter) Get a pre built CharFilter by its name or fallback to the default one
static PreBuiltCharFilters	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PreBuiltCharFilters[]	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

HTML_STRIP

public static final PreBuiltCharFilters HTML_STRIP

Field Detail

cache

protected final PreBuiltCacheFactory.PreBuiltCache<CharFilterFactory> cache

Method Detail

values

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

Returns:

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

valueOf

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

create

public abstract java.io.Reader create(java.io.Reader tokenStream,
                                      Version version)

getCharFilterFactory

public CharFilterFactory getCharFilterFactory(Version version)

getOrDefault

public static PreBuiltCharFilters getOrDefault(java.lang.String name,
                                               PreBuiltCharFilters defaultCharFilter)

Get a pre built CharFilter by its name or fallback to the default one

Parameters:

name - CharFilter name

defaultCharFilter - default CharFilter if name not found