Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
private Pattern	FILE_EXTENSION
private boolean	quotesWhitespaceCheck

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	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	Description
private static boolean	containsDigit(String str)
String	getCommaCharacter()
final 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.
private static boolean	isDigitOrDot(String str)
private boolean	isDomain(AnalyzedTokenReadings[] tokens, int i)	Case Insensitive check if the token at index i is a valid domain name (e.g.
protected boolean	isException(AnalyzedTokenReadings[] tokens, int tokenIdx)
private boolean	isFileExtension(AnalyzedTokenReadings[] tokens, int i)
private static boolean	isHyphenOrComma(String str)
private static boolean	isLeftBracket(String str)
private static boolean	isQuote(String str)
private static boolean	isRightBracket(String str)
private static boolean	isWhitespaceToken(AnalyzedTokenReadings token)
final RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.

Methods inherited from class org.languagetool.rules.Rule

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

Methods inherited from class java.lang.Object

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

Field Details

quotesWhitespaceCheck

private boolean quotesWhitespaceCheck

FILE_EXTENSION

private Pattern FILE_EXTENSION

Constructor Details

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 Details

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

isDomain

private boolean isDomain(AnalyzedTokenReadings[] tokens,
 int i)

Case Insensitive check if the token at index i is a valid domain name (e.g. "com", "org", "net", etc.)

Parameters:

tokens -

i -

Returns:

true if the token at index i is a domain name, false otherwise

isFileExtension

private boolean isFileExtension(AnalyzedTokenReadings[] tokens,
 int i)

isWhitespaceToken

private static boolean isWhitespaceToken(AnalyzedTokenReadings token)

isQuote

private static boolean isQuote(String str)

isHyphenOrComma

private static boolean isHyphenOrComma(String str)

isDigitOrDot

private static boolean isDigitOrDot(String str)

isLeftBracket

private static boolean isLeftBracket(String str)

isRightBracket

private static boolean isRightBracket(String str)

containsDigit

private static boolean containsDigit(String str)