org.languagetool.rules

Class GenericUnpairedBracketsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.GenericUnpairedBracketsRule

public class GenericUnpairedBracketsRule
extends TextLevelRule

Rule that finds unpaired quotes, brackets etc.

Author:

Marcin Miłkowski

Field Summary

Fields

Modifier and Type	Field and Description
protected Pattern	numerals
protected UnsyncStack<SymbolLocator>	symbolStack

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
GenericUnpairedBracketsRule(ResourceBundle messages) Construct rule with a set of default start and end symbols: [] () {} "" ''
GenericUnpairedBracketsRule(ResourceBundle messages, List<String> startSymbols, List<String> endSymbols)
GenericUnpairedBracketsRule(String ruleId, ResourceBundle messages, List<String> startSymbols, List<String> endSymbols)

Method Summary

Methods

Modifier and Type	Method and Description
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	isNoException(String token, AnalyzedTokenReadings[] tokens, int i, int j, boolean precSpace, boolean follSpace) Generic method to specify an exception.
RuleMatch[]	match(List<AnalyzedSentence> sentences)
protected void	uniqueMapInit()

Methods inherited from class org.languagetool.rules.TextLevelRule

match, reset

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Detail

symbolStack

protected final UnsyncStack<SymbolLocator> symbolStack

numerals

protected Pattern numerals

Constructor Detail

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(String ruleId,
                           ResourceBundle messages,
                           List<String> startSymbols,
                           List<String> endSymbols)

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(ResourceBundle messages,
                           List<String> startSymbols,
                           List<String> endSymbols)

Parameters:

startSymbols - start symbols like "(" - note that the array must be of equal length as the next parameter and the sequence of starting symbols must match exactly the sequence of ending symbols.

endSymbols - end symbols like ")"

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(ResourceBundle messages)

Construct rule with a set of default start and end symbols: [] () {} "" ''

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

uniqueMapInit

protected void uniqueMapInit()

isNoException

protected boolean isNoException(String token,
                    AnalyzedTokenReadings[] tokens,
                    int i,
                    int j,
                    boolean precSpace,
                    boolean follSpace)

Generic method to specify an exception. For unspecified language, it simply returns true (which means no exception) unless there's a common smiley like :-) or ;-).

Parameters:

token - String token

tokens - Sentence tokens

i - Current token index

precSpace - is preceded with space

follSpace - is followed with space

match

public final RuleMatch[] match(List<AnalyzedSentence> sentences)

Overrides:

match in class TextLevelRule