org.languagetool.rules.en

Class ContractionSpellingRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule

org.languagetool.rules.en.ContractionSpellingRule

public class ContractionSpellingRule
extends AbstractSimpleReplaceRule

A rule that matches words or phrases which should not be used and suggests correct ones instead, e.g. Hasnt instead of Hasn't.

Since:

2.5

Author:

Marcin Miłkowski

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTRACTION_SPELLING_RULE

Fields inherited from class org.languagetool.rules.AbstractSimpleReplaceRule

ignoreTaggedWords, subRuleSpecificIds

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
ContractionSpellingRule(ResourceBundle messages, Language language)

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.
Locale	getLocale()
String	getMessage(String tokenStr, List<String> replacements)
String	getShort()
Map<String,List<String>>	getWrongWords()
boolean	isCaseSensitive() Indicates if the rule is case-sensitive.

Methods inherited from class org.languagetool.rules.AbstractSimpleReplaceRule

createRuleMatch, findMatches, getSynthesizer, isCheckLemmas, isTagged, isTokenException, loadFromPath, loadFromPath, match, setCheckLemmas, setIgnoreTaggedWords, 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

CONTRACTION_SPELLING_RULE

public static final String CONTRACTION_SPELLING_RULE

See Also:

Constant Field Values

Constructor Detail

ContractionSpellingRule

public ContractionSpellingRule(ResourceBundle messages,
                               Language language)

Method Detail

getWrongWords

public Map<String,List<String>> getWrongWords()

Specified by:

getWrongWords in class AbstractSimpleReplaceRule

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 AbstractSimpleReplaceRule

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 AbstractSimpleReplaceRule

getShort

public String getShort()

Overrides:

getShort in class AbstractSimpleReplaceRule

getMessage

public String getMessage(String tokenStr,
                         List<String> replacements)

Overrides:

getMessage in class AbstractSimpleReplaceRule

isCaseSensitive

public boolean isCaseSensitive()

Description copied from class: AbstractSimpleReplaceRule

Indicates if the rule is case-sensitive. Default value is true.

Overrides:

isCaseSensitive in class AbstractSimpleReplaceRule

Returns:

true if the rule is case-sensitive, false otherwise.

getLocale

public Locale getLocale()

Overrides:

getLocale in class AbstractSimpleReplaceRule

Returns:

the locale used for case conversion when AbstractSimpleReplaceRule.isCaseSensitive() is set to false.