RemoteRuleMatch (LanguageTool 6.4-SNAPSHOT API)

java.lang.Object
- org.languagetool.remote.RemoteRuleMatch

```
public class RemoteRuleMatch
extends Object
```
A potential error as returned by the HTTP API of LanguageTool.

Since:

3.4

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`getCategory()` The error's category.
`Optional<String>`	`getCategoryId()` The id of the error's category.
`String`	`getContext()` The error in its context.
`int`	`getContextOffset()` The character position of the error start inside the result of `getContext()`.
`int`	`getErrorLength()` The length of the error in characters.
`int`	`getErrorOffset()` The character position where the error starts.
`Optional<String>`	`getLocQualityIssueType()`
`String`	`getMessage()` A text describing the error to the user.
`Optional<List<String>>`	`getReplacements()` Potential corrections for the error.
`String`	`getRuleDescription()` Description of the rule.
`String`	`getRuleId()` Unique (per language) identifier for the error.
`Optional<String>`	`getRuleSubId()` Optional sub id (rule groups have a sub id for each rule).
`Optional<String>`	`getShortMessage()` Optional short message describing the error.
`Optional<String>`	`getUrl()` URL with a more detailed explanation of the error.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getRuleId
```
public String getRuleId()
```
    Unique (per language) identifier for the error.
  - getRuleDescription
```
public String getRuleDescription()
```
    Description of the rule.
  - getRuleSubId
```
public Optional<String> getRuleSubId()
```
    Optional sub id (rule groups have a sub id for each rule).
  - getMessage
```
public String getMessage()
```
    A text describing the error to the user.
  - getShortMessage
```
public Optional<String> getShortMessage()
```
    Optional short message describing the error.
  - getReplacements
```
public Optional<List<String>> getReplacements()
```
    Potential corrections for the error. Note that corrections might be wrong and they are not necessarily ordered by quality.
  - getContext
```
public String getContext()
```
    The error in its context. See getContextOffset() and getErrorLength() to get the exact position.
  - getContextOffset
```
public int getContextOffset()
```
    The character position of the error start inside the result of getContext().
  - getErrorOffset
```
public int getErrorOffset()
```
    The character position where the error starts.
  - getErrorLength
```
public int getErrorLength()
```
    The length of the error in characters.
  - getUrl
```
public Optional<String> getUrl()
```
    URL with a more detailed explanation of the error.
  - getCategory
```
public Optional<String> getCategory()
```
    The error's category.
  - getCategoryId
```
public Optional<String> getCategoryId()
```
    The id of the error's category.
  - getLocQualityIssueType
```
public Optional<String> getLocQualityIssueType()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RemoteRuleMatch

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRuleId

getRuleDescription

getRuleSubId

getMessage

getShortMessage

getReplacements

getContext

getContextOffset

getErrorOffset

getErrorLength

getUrl

getCategory

getCategoryId

getLocQualityIssueType

toString