org.languagetool.tools

Class RuleMatchesAsJsonSerializer

java.lang.Object

org.languagetool.tools.RuleMatchesAsJsonSerializer

public class RuleMatchesAsJsonSerializer
extends Object

Write rule matches and some meta information as JSON.

Since:

3.4, public since 3.6

Constructor Summary

Constructors

Constructor and Description
RuleMatchesAsJsonSerializer()
RuleMatchesAsJsonSerializer(int compactMode)
RuleMatchesAsJsonSerializer(int compactMode, Language lang)

Method Summary

Modifier and Type	Method and Description
String	ruleMatchesToJson(List<RuleMatch> matches, List<RuleMatch> hiddenMatches, AnnotatedText text, int contextSize, DetectedLanguage detectedLang, String incompleteResultsReason, boolean showPremiumHint)
String	ruleMatchesToJson(List<RuleMatch> matches, List<RuleMatch> hiddenMatches, String text, int contextSize, DetectedLanguage detectedLang, String incompleteResultsReason)
String	ruleMatchesToJson(List<RuleMatch> matches, String text, int contextSize, DetectedLanguage detectedLang)
String	ruleMatchesToJson2(List<CheckResults> res, List<RuleMatch> hiddenMatches, AnnotatedText text, int contextSize, DetectedLanguage detectedLang, String incompleteResultsReason, boolean showPremiumHint, JLanguageTool.Mode mode)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleMatchesAsJsonSerializer

public RuleMatchesAsJsonSerializer()

RuleMatchesAsJsonSerializer

public RuleMatchesAsJsonSerializer(int compactMode)

Since:

4.7

RuleMatchesAsJsonSerializer

public RuleMatchesAsJsonSerializer(int compactMode,
                                   Language lang)

Since:

5.1

Method Detail

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
                                String text,
                                int contextSize,
                                DetectedLanguage detectedLang)

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
                                List<RuleMatch> hiddenMatches,
                                String text,
                                int contextSize,
                                DetectedLanguage detectedLang,
                                String incompleteResultsReason)

Parameters:

incompleteResultsReason - use a string that explains why results are incomplete (e.g. due to a timeout) - a 'warnings' section will be added to the JSON. Use null if results are complete.

Since:

3.7

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
                                List<RuleMatch> hiddenMatches,
                                AnnotatedText text,
                                int contextSize,
                                DetectedLanguage detectedLang,
                                String incompleteResultsReason,
                                boolean showPremiumHint)

Parameters:

incompleteResultsReason - use a string that explains why results are incomplete (e.g. due to a timeout) - a 'warnings' section will be added to the JSON. Use null if results are complete.

Since:

4.3

ruleMatchesToJson2

public String ruleMatchesToJson2(List<CheckResults> res,
                                 List<RuleMatch> hiddenMatches,
                                 AnnotatedText text,
                                 int contextSize,
                                 DetectedLanguage detectedLang,
                                 String incompleteResultsReason,
                                 boolean showPremiumHint,
                                 JLanguageTool.Mode mode)

Parameters:

incompleteResultsReason - use a string that explains why results are incomplete (e.g. due to a timeout) - a 'warnings' section will be added to the JSON. Use null if results are complete.

Since:

5.3