org.puimula.libvoikko

Enum SuggestionStrategy

java.lang.Object

java.lang.Enum<SuggestionStrategy>

org.puimula.libvoikko.SuggestionStrategy

All Implemented Interfaces:

Serializable, Comparable<SuggestionStrategy>

public enum SuggestionStrategy
extends Enum<SuggestionStrategy>

Strategies for generating suggestions for incorrectly spelled words.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OCR Suggestion strategy for correcting errors in text produced by optical character recognition software.
TYPO Suggestion strategy for correcting human typing errors.

Method Summary

Methods

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

TYPO

public static final SuggestionStrategy TYPO

Suggestion strategy for correcting human typing errors.

OCR

public static final SuggestionStrategy OCR

Suggestion strategy for correcting errors in text produced by optical character recognition software.

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

Returns:

the id