com.groupdocs.search.dictionaries

Enum CharacterType

java.lang.Object

java.lang.Enum<CharacterType>

com.groupdocs.search.dictionaries.CharacterType

All Implemented Interfaces:

Serializable, Comparable<CharacterType>

public enum CharacterType
extends Enum<CharacterType>

Represents a type of a character, depending on how it should be indexed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Blended Both the separator and the valid character.
Letter The valid character.
SeparateWord The character that represents a whole word.
Separator The separator character.

Method Summary

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

Blended

public static final CharacterType Blended

Both the separator and the valid character.

Letter

public static final CharacterType Letter

The valid character.

SeparateWord

public static final CharacterType SeparateWord

The character that represents a whole word.

Separator

public static final CharacterType Separator

The separator character.

Method Detail

valueOf

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

values

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

Returns:

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