org.languagetool.rules

Class CommaWhitespaceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.CommaWhitespaceRule

Direct Known Subclasses:

ArabicCommaWhitespaceRule, ArabicQuestionMarkWhitespaceRule, ArabicSemiColonWhitespaceRule, GermanCommaWhitespaceRule, PersianCommaWhitespaceRule, UkrainianCommaWhitespaceRule

public class CommaWhitespaceRule
extends Rule

A rule that matches periods, commas and closing parenthesis preceded by whitespace and opening parenthesis followed by whitespace.

Author:

Daniel Naber

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
CommaWhitespaceRule(ResourceBundle messages) Deprecated. use CommaWhitespaceRule(ResourceBundle, IncorrectExample, CorrectExample) instead (deprecated since 3.3)
CommaWhitespaceRule(ResourceBundle messages, boolean quotesWhitespace)
CommaWhitespaceRule(ResourceBundle messages, IncorrectExample incorrectExample, CorrectExample correctExample)
CommaWhitespaceRule(ResourceBundle messages, IncorrectExample incorrectExample, CorrectExample correctExample, URL url)

Method Summary

Modifier and Type	Method and Description
String	getCommaCharacter()
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId() A string used to identify the rule in e.g. configuration files.
protected boolean	isException(AnalyzedTokenReadings[] tokens, int tokenIdx)
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Constructor Detail

CommaWhitespaceRule

public CommaWhitespaceRule(ResourceBundle messages,
                           IncorrectExample incorrectExample,
                           CorrectExample correctExample,
                           URL url)

Since:

5.9

CommaWhitespaceRule

public CommaWhitespaceRule(ResourceBundle messages,
                           IncorrectExample incorrectExample,
                           CorrectExample correctExample)

Since:

3.3

CommaWhitespaceRule

public CommaWhitespaceRule(ResourceBundle messages,
                           boolean quotesWhitespace)

CommaWhitespaceRule

public CommaWhitespaceRule(ResourceBundle messages)

Deprecated. use CommaWhitespaceRule(ResourceBundle, IncorrectExample, CorrectExample) instead (deprecated since 3.3)

Method Detail

getId

public String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class Rule

getDescription

public final String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class Rule

getCommaCharacter

public String getCommaCharacter()

isException

protected boolean isException(AnalyzedTokenReadings[] tokens,
                              int tokenIdx)

Returns:

Returns true if there exception to this rule

Since:

5.3

match

public final RuleMatch[] match(AnalyzedSentence sentence)

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different from the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects