Language (LanguageTool Style and Grammar Checker Core 3.0 API)

java.lang.Object
- org.languagetool.Language

```
public abstract class Language
extends Object
```
Base class for any supported language (English, German, etc). Language classes are detected at runtime by searching the classpath for files named META-INF/org/languagetool/language-module.properties. Those file(s) need to contain a key languageClasses which specifies the fully qualified class name(s), e.g. org.languagetool.language.English. Use commas to specify more than one class.
Sub classes should typically use lazy init for anything that's costly to set up. This improves start up time for the LanguageTool stand-alone version.

Constructor Summary

Constructors
Constructor and Description

Language()

Constructors
Constructor and Description
`Language()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equalsConsiderVariantsIfSpecified(Language otherLanguage)` Return true if this is the same language as the given one, considering country variants only if set for both languages.
`Chunker`	`getChunker()` Get this language's chunker implementation or `null`.
`abstract String[]`	`getCountries()` Get this language's country options , e.g.
`List<String>`	`getDefaultDisabledRulesForVariant()` Get disabled rules different from the default ones for this language variant.
`List<String>`	`getDefaultEnabledRulesForVariant()` Get enabled rules different from the default ones for this language variant.
`Language`	`getDefaultLanguageVariant()` Languages that have country variants need to overwrite this to select their most common variant.
`Unifier`	`getDisambiguationUnifier()` Get this language's feature unifier used for disambiguation.
`UnifierConfiguration`	`getDisambiguationUnifierConfiguration()`
`Disambiguator`	`getDisambiguator()` Get this language's part-of-speech disambiguator implementation.
`Pattern`	`getIgnoredCharactersRegex()`
`LanguageModel`	`getLanguageModel(File indexDir)`
`Locale`	`getLocale()` Get this language's Java locale, not considering the country code.
`Locale`	`getLocaleWithCountryAndVariant()` Get this language's Java locale, considering language code and country code (if any).
`abstract Contributor[]`	`getMaintainers()` Get the name(s) of the maintainer(s) for this language or `null`.
`abstract String`	`getName()` Get this language's name in English, e.g.
`protected List<PatternRule>`	`getPatternRules()` Get the pattern rules as defined in the files returned by `getRuleFileNames()`.
`Chunker`	`getPostDisambiguationChunker()` Get this language's chunker implementation or `null`.
`List<Rule>`	`getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel)` Get a list of rules that require a `LanguageModel`.
`abstract List<Rule>`	`getRelevantRules(ResourceBundle messages)` Get the rules classes that should run for texts in this language.
`List<String>`	`getRuleFileNames()` Get the location of the rule file(s) in a form like `/org/languagetool/rules/de/grammar.xml`, i.e. a path in the classpath.
`SentenceTokenizer`	`getSentenceTokenizer()` Get this language's sentence tokenizer implementation.
`abstract String`	`getShortName()` Get this language's character code, e.g.
`String`	`getShortNameWithCountryAndVariant()` Get the short name of the language with country and variant (if any), if it is a single-country language.
`Synthesizer`	`getSynthesizer()` Get this language's part-of-speech synthesizer implementation or `null`.
`Tagger`	`getTagger()` Get this language's part-of-speech tagger implementation.
`String`	`getTranslatedName(ResourceBundle messages)` Get the name of the language translated to the current locale, if available.
`Unifier`	`getUnifier()` Get this language's feature unifier.
`UnifierConfiguration`	`getUnifierConfiguration()`
`String`	`getVariant()` Get this language's variant, e.g.
`Tokenizer`	`getWordTokenizer()` Get this language's word tokenizer implementation.
`boolean`	`hasVariant()` Whether this class has at least one subclass that implements variants of this language.
`boolean`	`isExternal()`
`boolean`	`isVariant()` Whether this is a country variant of another language, i.e. whether it doesn't directly extend `Language`, but a subclass of `Language`.
`void`	`makeExternal()` Deprecated. overwrite `isExternal()` instead (deprecated since 3.0)
`void`	`setIgnoredCharactersRegex(String ignoredCharactersRegex)` Deprecated. overwrite `getIgnoredCharactersRegex()` instead (deprecated since 3.0)
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Language
```
public Language()
```
- Method Detail
  - getShortName
```
public abstract String getShortName()
```
    Get this language's character code, e.g. en for English. The country parameter (e.g. "US"), if any, is not returned.
    
    Returns:
    language code
  - getName
```
public abstract String getName()
```
    Get this language's name in English, e.g. English or German (Germany).
    
    Returns:
    language name
  - getCountries
```
public abstract String[] getCountries()
```
    Get this language's country options , e.g. US (as in en-US) or PL (as in pl-PL).
    
    Returns:
    String[] - array of country options for the language.
  - getMaintainers
```
@Nullable
public abstract Contributor[] getMaintainers()
```
    Get the name(s) of the maintainer(s) for this language or null.
  - getRelevantRules
```
public abstract List<Rule> getRelevantRules(ResourceBundle messages)
                                     throws IOException
```
    Get the rules classes that should run for texts in this language.
    
    Throws:
    
    IOException
    Since:
    
    1.4 (signature modified in 2.7)
  - getVariant
```
@Nullable
public String getVariant()
```
    Get this language's variant, e.g. valencia (as in ca-ES-valencia) or null. Attention: not to be confused with "country" option
    
    Returns:
    variant for the language or null
    Since:
    
    2.3
  - getDefaultEnabledRulesForVariant
```
public List<String> getDefaultEnabledRulesForVariant()
```
    Get enabled rules different from the default ones for this language variant.
    
    Returns:
    enabled rules for the language variant.
    Since:
    
    2.4
  - getDefaultDisabledRulesForVariant
```
public List<String> getDefaultDisabledRulesForVariant()
```
    Get disabled rules different from the default ones for this language variant.
    
    Returns:
    disabled rules for the language variant.
    Since:
    
    2.4
  - getLanguageModel
```
@Nullable
public LanguageModel getLanguageModel(File indexDir)
                               throws IOException
```
    Parameters:
    indexDir - directory with a '3grams' sub directory which contains a Lucene index with 3gram occurrence counts
    
    Returns:
    a LanguageModel or null if this language doesn't support one
    
    Throws:
    
    IOException
    Since:
    
    2.7
  - getRelevantLanguageModelRules
```
public List<Rule> getRelevantLanguageModelRules(ResourceBundle messages,
                                       LanguageModel languageModel)
                                         throws IOException
```
    Get a list of rules that require a LanguageModel. Returns an empty list for languages that don't have such rules.
    
    Throws:
    
    IOException
    Since:
    
    2.7
  - getLocale
```
public Locale getLocale()
```
    Get this language's Java locale, not considering the country code.
  - getLocaleWithCountryAndVariant
```
public Locale getLocaleWithCountryAndVariant()
```
    Get this language's Java locale, considering language code and country code (if any).
    
    Since:
    
    2.1
  - getRuleFileNames
```
public List<String> getRuleFileNames()
```
    Get the location of the rule file(s) in a form like /org/languagetool/rules/de/grammar.xml, i.e. a path in the classpath.
  - getDefaultLanguageVariant
```
@Nullable
public Language getDefaultLanguageVariant()
```
    Languages that have country variants need to overwrite this to select their most common variant.
    
    Returns:
    default country variant or null
    Since:
    
    1.8
  - getDisambiguator
```
public Disambiguator getDisambiguator()
```
    Get this language's part-of-speech disambiguator implementation.
  - getTagger
```
public Tagger getTagger()
```
    Get this language's part-of-speech tagger implementation. The tagger must not be null, but it can be a trivial pseudo-tagger that only assigns null tags.
  - getSentenceTokenizer
```
public SentenceTokenizer getSentenceTokenizer()
```
    Get this language's sentence tokenizer implementation.
  - getWordTokenizer
```
public Tokenizer getWordTokenizer()
```
    Get this language's word tokenizer implementation.
  - getChunker
```
@Nullable
public Chunker getChunker()
```
    Get this language's chunker implementation or null.
    
    Since:
    
    2.3
  - getPostDisambiguationChunker
```
@Nullable
public Chunker getPostDisambiguationChunker()
```
    Get this language's chunker implementation or null.
    
    Since:
    
    2.9
  - getSynthesizer
```
@Nullable
public Synthesizer getSynthesizer()
```
    Get this language's part-of-speech synthesizer implementation or null.
  - getUnifier
```
public Unifier getUnifier()
```
    Get this language's feature unifier.
    
    Returns:
    Feature unifier for analyzed tokens.
  - getDisambiguationUnifier
```
public Unifier getDisambiguationUnifier()
```
    Get this language's feature unifier used for disambiguation. Note: it might be different from the normal rule unifier.
    
    Returns:
    Feature unifier for analyzed tokens.
  - getUnifierConfiguration
```
public UnifierConfiguration getUnifierConfiguration()
```
    Since:
    
    2.3
  - getDisambiguationUnifierConfiguration
```
public UnifierConfiguration getDisambiguationUnifierConfiguration()
```
    Since:
    
    2.3
  - getTranslatedName
```
public final String getTranslatedName(ResourceBundle messages)
```
    Get the name of the language translated to the current locale, if available. Otherwise, get the untranslated name.
  - getShortNameWithCountryAndVariant
```
public final String getShortNameWithCountryAndVariant()
```
    Get the short name of the language with country and variant (if any), if it is a single-country language. For generic language classes, get only a two- or three-character code.
    
    Since:
    
    1.8
  - getPatternRules
```
protected List<PatternRule> getPatternRules()
                                     throws IOException
```
    Get the pattern rules as defined in the files returned by getRuleFileNames().
    
    Throws:
    
    IOException
    Since:
    
    2.7
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - isVariant
```
public final boolean isVariant()
```
    Whether this is a country variant of another language, i.e. whether it doesn't directly extend Language, but a subclass of Language.
    
    Since:
    
    1.8
  - hasVariant
```
public final boolean hasVariant()
```
    Whether this class has at least one subclass that implements variants of this language.
    
    Since:
    
    1.8
  - isExternal
```
public boolean isExternal()
```
  - makeExternal
```
public void makeExternal()
```
    Deprecated. overwrite isExternal() instead (deprecated since 3.0)
    
    Sets the language as external. Useful for making a copy of an existing language.
    
    Since:
    
    2.6
  - equalsConsiderVariantsIfSpecified
```
public boolean equalsConsiderVariantsIfSpecified(Language otherLanguage)
```
    Return true if this is the same language as the given one, considering country variants only if set for both languages. For example: en = en, en = en-GB, en-GB = en-GB, but en-US != en-GB
    
    Since:
    
    1.8
  - getIgnoredCharactersRegex
```
public Pattern getIgnoredCharactersRegex()
```
    Returns:
    Return compiled regular expression to ignore inside tokens
    Since:
    
    2.9
  - setIgnoredCharactersRegex
```
public void setIgnoredCharactersRegex(String ignoredCharactersRegex)
```
    Deprecated. overwrite getIgnoredCharactersRegex() instead (deprecated since 3.0)
    
    Sets the regular expression (usually set of chars) to ignore inside tokens. By default only soft hyphen () is ignored.
    
    Since:
    
    2.9

Class Language

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Language

Method Detail

getShortName

getName

getCountries

getMaintainers

getRelevantRules

getVariant

getDefaultEnabledRulesForVariant

getDefaultDisabledRulesForVariant

getLanguageModel

getRelevantLanguageModelRules

getLocale

getLocaleWithCountryAndVariant

getRuleFileNames

getDefaultLanguageVariant

getDisambiguator

getTagger

getSentenceTokenizer

getWordTokenizer

getChunker

getPostDisambiguationChunker

getSynthesizer

getUnifier

getDisambiguationUnifier

getUnifierConfiguration

getDisambiguationUnifierConfiguration

getTranslatedName

getShortNameWithCountryAndVariant

getPatternRules

toString

isVariant

hasVariant

isExternal

makeExternal

equalsConsiderVariantsIfSpecified

getIgnoredCharactersRegex

setIgnoredCharactersRegex