org.languagetool.rules

Class Example

java.lang.Object

org.languagetool.rules.Example

public final class Example
extends Object

Helper class to create error examples. For internal use by LanguageTool only.

Since:

2.5

Method Summary

Methods

Modifier and Type	Method and Description
static String	fixed(String example) Create an example text (usually just one sentence) without an error - the fixed error (compared to the text created with wrong(String)) must be marked with {@code ...
static IncorrectExample	wrong(String example) Create an example text (usually just one sentence) with an error - the error must be marked with {@code ...

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

wrong

public static IncorrectExample wrong(String example)

Create an example text (usually just one sentence) with an error - the error must be marked with <marker>...</marker>.

Throws:

IllegalArgumentException - if the <marker>...</marker> is missing

Since:

2.5

fixed

public static String fixed(String example)

Create an example text (usually just one sentence) without an error - the fixed error (compared to the text created with wrong(String)) must be marked with <marker>...</marker>.

Throws:

IllegalArgumentException - if the <marker>...</marker> is missing

Since:

2.5