org.languagetool.rules.en

Class AmericanReplaceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule2

org.languagetool.rules.en.AmericanReplaceRule

public class AmericanReplaceRule
extends AbstractSimpleReplaceRule2

A rule that matches words or phrases which should not be used and suggests correct ones instead.

Author:

Marcin Miłkowski

Nested Class Summary

Nested classes/interfaces inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

AbstractSimpleReplaceRule2.CaseSensitivy

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMERICAN_SIMPLE_REPLACE_RULE

Fields inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

subRuleSpecificIds

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AmericanReplaceRule(ResourceBundle messages, String path)

Method Summary

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.
List<String>	getFileNames()
String	getId() A string used to identify the rule in e.g. configuration files.
Locale	getLocale() locale used on case-conversion
String	getMessage()
String	getShort()

Methods inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

addToQueue, checkKeyWordsAreKnownToSpeller, checkKeyWordsAreUnknownToSpeller, getCaseSensitivy, getDescription, getFilePaths, getSuggestionsSeparator, getWrongWords, isException, isTokenException, match, separateKeyWordsBySpeller, useSubRuleSpecificIds

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

Field Detail

AMERICAN_SIMPLE_REPLACE_RULE

public static final String AMERICAN_SIMPLE_REPLACE_RULE

See Also:

Constant Field Values

Constructor Detail

AmericanReplaceRule

public AmericanReplaceRule(ResourceBundle messages,
                           String path)

Method Detail

getFileNames

public List<String> getFileNames()

Specified by:

getFileNames in class AbstractSimpleReplaceRule2

getId

public final 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 AbstractSimpleReplaceRule2

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 AbstractSimpleReplaceRule2

Returns:

A string where $match will be replaced with the matching word.

getShort

public String getShort()

Specified by:

getShort in class AbstractSimpleReplaceRule2

getMessage

public String getMessage()

Specified by:

getMessage in class AbstractSimpleReplaceRule2

Returns:

A string where $match will be replaced with the matching word and $suggestions will be replaced with the alternatives. This is the string shown to the user.

getLocale

public Locale getLocale()

Description copied from class: AbstractSimpleReplaceRule2

locale used on case-conversion

Specified by:

getLocale in class AbstractSimpleReplaceRule2