org.languagetool.tools

Enum StringTools.ApiPrintMode

java.lang.Object

java.lang.Enum<StringTools.ApiPrintMode>

org.languagetool.tools.StringTools.ApiPrintMode

All Implemented Interfaces:

Serializable, Comparable<StringTools.ApiPrintMode>

Enclosing class:

StringTools

public static enum StringTools.ApiPrintMode
extends Enum<StringTools.ApiPrintMode>

Constants for printing XML rule matches.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE_API Simply continue rule match output.
END_API End XML/JSON output by closing the root element.
NORMAL_API Normally output the rule matches by starting and ending the XML/JSON output on every call.
START_API Start XML/JSON output by printing the preamble and the start of the root element.

Method Summary

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

NORMAL_API

public static final StringTools.ApiPrintMode NORMAL_API

Normally output the rule matches by starting and ending the XML/JSON output on every call.

START_API

public static final StringTools.ApiPrintMode START_API

Start XML/JSON output by printing the preamble and the start of the root element.

END_API

public static final StringTools.ApiPrintMode END_API

End XML/JSON output by closing the root element.

CONTINUE_API

public static final StringTools.ApiPrintMode CONTINUE_API

Simply continue rule match output.

Method Detail

values

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

Returns:

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

valueOf

public static StringTools.ApiPrintMode 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