org.languagetool.language

Class BritishEnglish

java.lang.Object

org.languagetool.Language

org.languagetool.language.English

org.languagetool.language.BritishEnglish

All Implemented Interfaces:

AutoCloseable

public class BritishEnglish
extends English

Field Summary

Fields inherited from class org.languagetool.language.English

cache

Constructor Summary

Constructors

Constructor and Description
BritishEnglish()

Method Summary

Modifier and Type	Method and Description
SpellingCheckRule	createDefaultSpellingRule(ResourceBundle messages)
String[]	getCountries() Get this language's country options , e.g.
String	getName() Get this language's name in English, e.g.
protected int	getPriorityForId(String id) Returns a priority for Rule or Category Id (default: 0).
List<Rule>	getRelevantLanguageModelCapableRules(ResourceBundle messages, LanguageModel lm, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages) Get a list of rules that can optionally use a LanguageModel.
List<Rule>	getRelevantRules(ResourceBundle messages, UserConfig userConfig, Language motherTongue, List<Language> altLanguages) Get the rules classes that should run for texts in this language.

Methods inherited from class org.languagetool.language.English

adaptSuggestions, close, createDefaultChunker, createDefaultDisambiguator, createDefaultSentenceTokenizer, createDefaultSynthesizer, createDefaultTagger, createDefaultWordTokenizer, getClosingDoubleQuote, getClosingSingleQuote, getDefaultLanguageVariant, getLanguageModel, getMaintainedState, getMaintainers, getOpeningDoubleQuote, getOpeningSingleQuote, getRelevantLanguageModelRules, getRemoteEnhancedRules, getRulePriority, getShortCode, hasMinMatchesRules, hasNGramFalseFriendRule, isAdvancedTypographyEnabled

Methods inherited from class org.languagetool.Language

adaptSuggestion, adjustMatch, createDefaultJLanguageTool, createDefaultPostDisambiguationChunker, equals, equalsConsiderVariantsIfSpecified, getChunker, getCommonWordsPath, getConsistencyRulePrefix, getDefaultDisabledRulesForVariant, getDefaultEnabledRulesForVariant, getDefaultSpellingRule, getDefaultSpellingRule, getDisambiguationUnifier, getDisambiguationUnifierConfiguration, getDisambiguator, getIgnoredCharactersRegex, getLocale, getLocaleWithCountryAndVariant, getPatternRules, getPostDisambiguationChunker, getRelevantRemoteRules, getRelevantRulesGlobalConfig, getRuleFileNames, getSentenceTokenizer, getShortCodeWithCountryAndVariant, getSynthesizer, getTagger, getTranslatedName, getUnifier, getUnifierConfiguration, getVariant, getWordTokenizer, hashCode, hasVariant, initLanguageModel, isExternal, isHiddenFromGui, isSpellcheckOnlyLanguage, isVariant, mergeSuggestions, setChunker, setDisambiguator, setPostDisambiguationChunker, setSentenceTokenizer, setSynthesizer, setTagger, setWordTokenizer, toAdvancedTypography, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BritishEnglish

public BritishEnglish()

Method Detail

getCountries

public String[] getCountries()

Description copied from class: Language

Get this language's country options , e.g. US (as in en-US) or PL (as in pl-PL).

Overrides:

getCountries in class English

Returns:

String[] - array of country options for the language.

getName

public String getName()

Description copied from class: Language

Get this language's name in English, e.g. English or German (Germany).

Overrides:

getName in class English

Returns:

language name

getRelevantRules

public List<Rule> getRelevantRules(ResourceBundle messages,
                                   UserConfig userConfig,
                                   Language motherTongue,
                                   List<Language> altLanguages)
                            throws IOException

Description copied from class: Language

Get the rules classes that should run for texts in this language.

Overrides:

getRelevantRules in class English

Throws:

IOException

createDefaultSpellingRule

public SpellingCheckRule createDefaultSpellingRule(ResourceBundle messages)
                                            throws IOException

Overrides:

createDefaultSpellingRule in class English

Throws:

IOException

getRelevantLanguageModelCapableRules

public List<Rule> getRelevantLanguageModelCapableRules(ResourceBundle messages,
                                                       @Nullable
                                                       LanguageModel lm,
                                                       GlobalConfig globalConfig,
                                                       UserConfig userConfig,
                                                       Language motherTongue,
                                                       List<Language> altLanguages)
                                                throws IOException

Description copied from class: Language

Get a list of rules that can optionally use a LanguageModel. Returns an empty list for languages that don't have such rules.

Overrides:

getRelevantLanguageModelCapableRules in class English

lm - null if no language model is available

Throws:

IOException

getPriorityForId

protected int getPriorityForId(String id)

Description copied from class: Language

Returns a priority for Rule or Category Id (default: 0). Positive integers have higher priority. Negative integers have lower priority.

Overrides:

getPriorityForId in class English