org.languagetool.rules

Enum SuggestedReplacement.SuggestionType

java.lang.Object

java.lang.Enum<SuggestedReplacement.SuggestionType>

org.languagetool.rules.SuggestedReplacement.SuggestionType

All Implemented Interfaces:

Serializable, Comparable<SuggestedReplacement.SuggestionType>

Enclosing class:

SuggestedReplacement

public static enum SuggestedReplacement.SuggestionType
extends Enum<SuggestedReplacement.SuggestionType>

classify the type of the suggestion so that downstream tasks (e.g. resorting, as in BERTSuggestionRanking) can treat them accordingly Default - default, no special treatment Translation - offers to translate words from native language into text language; suggestion ranking extends size of list of candidates Curated - a manually curated suggestion / special case / ...; don't resort

Enum Constant Summary

Enum Constants

Enum Constant and Description
Curated
Default
Translation

Method Summary

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

Default

public static final SuggestedReplacement.SuggestionType Default

Translation

public static final SuggestedReplacement.SuggestionType Translation

Curated

public static final SuggestedReplacement.SuggestionType Curated

Method Detail

values

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

Returns:

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

valueOf

public static SuggestedReplacement.SuggestionType 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