org.languagetool

Enum JLanguageTool.Mode

java.lang.Object

java.lang.Enum<JLanguageTool.Mode>

org.languagetool.JLanguageTool.Mode

All Implemented Interfaces:

Serializable, Comparable<JLanguageTool.Mode>

Enclosing class:

JLanguageTool

public static enum JLanguageTool.Mode
extends Enum<JLanguageTool.Mode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Use all active rules for checking.
ALL_BUT_TEXTLEVEL_ONLY Use all activate rules for checking except the text-level rules.
TEXTLEVEL_ONLY Use only text-level rules for checking.

Method Summary

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

ALL

public static final JLanguageTool.Mode ALL

Use all active rules for checking.

TEXTLEVEL_ONLY

public static final JLanguageTool.Mode TEXTLEVEL_ONLY

Use only text-level rules for checking. This is typically much faster then using all rules or ALL_BUT_TEXTLEVEL_ONLY.

ALL_BUT_TEXTLEVEL_ONLY

public static final JLanguageTool.Mode ALL_BUT_TEXTLEVEL_ONLY

Use all activate rules for checking except the text-level rules.

Method Detail

values

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

Returns:

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

valueOf

public static JLanguageTool.Mode 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