org.languagetool.rules.en

Class EnglishSpecificCaseRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSpecificCaseRule

org.languagetool.rules.en.EnglishSpecificCaseRule

public class EnglishSpecificCaseRule
extends AbstractSpecificCaseRule

A rule that matches words which need a specific upper/lowercase spelling.

Since:

4.8

Field Summary

Fields inherited from class org.languagetool.rules.AbstractSpecificCaseRule

phrasesListLoader

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
EnglishSpecificCaseRule(ResourceBundle messages)

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.
String	getId() A string used to identify the rule in e.g. configuration files.
String	getInitialCapitalMessage()
String	getOtherCapitalizationMessage()
String	getPhrasesPath()
String	getShortMessage()

Methods inherited from class org.languagetool.rules.AbstractSpecificCaseRule

match

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

EnglishSpecificCaseRule

public EnglishSpecificCaseRule(ResourceBundle messages)

Method Detail

getPhrasesPath

public String getPhrasesPath()

Specified by:

getPhrasesPath in class AbstractSpecificCaseRule

Returns:

the path to the txt file that contains the phrases for the rule

getInitialCapitalMessage

public String getInitialCapitalMessage()

Overrides:

getInitialCapitalMessage in class AbstractSpecificCaseRule

Returns:

the message that will be shown if the words of the wrongly capitalized phrase must begin with capital

getOtherCapitalizationMessage

public String getOtherCapitalizationMessage()

Overrides:

getOtherCapitalizationMessage in class AbstractSpecificCaseRule

Returns:

the message that will be shown if the wrongly capitalized phrase must not be written with capital initials (another special kind of capitalization)

getShortMessage

public String getShortMessage()

Overrides:

getShortMessage in class AbstractSpecificCaseRule

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.

Overrides:

getId in class AbstractSpecificCaseRule

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.

Overrides:

getDescription in class AbstractSpecificCaseRule