French (LanguageTool 6.4-SNAPSHOT API)

java.lang.Object
- org.languagetool.Language
- - org.languagetool.language.French

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BelgianFrench, CanadianFrench, SwissFrench
```
public class French
extends Language
implements AutoCloseable
```

Constructor Summary

Constructors
Constructor and Description

French()

Constructors
Constructor and Description
`French()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<RuleMatch>`	`adaptSuggestions(List<RuleMatch> ruleMatches, Set<String> enabledRules)`
`void`	`close()` Closes the language model, if any.
`Disambiguator`	`createDefaultDisambiguator()` Creates language specific disambiguator.
`SentenceTokenizer`	`createDefaultSentenceTokenizer()` Creates language specific sentence tokenizer.
`SpellingCheckRule`	`createDefaultSpellingRule(ResourceBundle messages)`
`Synthesizer`	`createDefaultSynthesizer()` Creates language specific part-of-speech synthesizer.
`Tagger`	`createDefaultTagger()` Creates language specific part-of-speech tagger.
`Tokenizer`	`createDefaultWordTokenizer()` Creates language specific word tokenizer.
`String`	`getClosingDoubleQuote()`
`String`	`getClosingSingleQuote()`
`String[]`	`getCountries()` Get this language's country options , e.g.
`Language`	`getDefaultLanguageVariant()` Languages that have country variants need to overwrite this to select their most common variant.
`LanguageModel`	`getLanguageModel(File indexDir)`
`LanguageMaintainedState`	`getMaintainedState()` Information about whether the support for this language in LanguageTool is actively maintained.
`Contributor[]`	`getMaintainers()` Get the name(s) of the maintainer(s) for this language or `null`.
`String`	`getName()` Get this language's name in English, e.g.
`String`	`getOpeningDoubleQuote()`
`String`	`getOpeningSingleQuote()`
`protected int`	`getPriorityForId(String id)` Returns a priority for Rule or Category Id (default: 0).
`List<Rule>`	`getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel, UserConfig userConfig)` Get a list of rules that require 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.
`List<Rule>`	`getRelevantRulesGlobalConfig(ResourceBundle messages, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)` Get the rules classes that should run for texts in this language.
`String`	`getShortCode()` Get this language's character code, e.g.
`boolean`	`hasMinMatchesRules()`
`boolean`	`isAdvancedTypographyEnabled()`
`String`	`toAdvancedTypography(String input)`

Methods inherited from class org.languagetool.Language
adaptSuggestion, adjustMatch, createDefaultChunker, createDefaultJLanguageTool, createDefaultPostDisambiguationChunker, equals, equalsConsiderVariantsIfSpecified, getChunker, getCommonWordsPath, getConsistencyRulePrefix, getDefaultDisabledRulesForVariant, getDefaultEnabledRulesForVariant, getDefaultSpellingRule, getDefaultSpellingRule, getDisambiguationUnifier, getDisambiguationUnifierConfiguration, getDisambiguator, getIgnoredCharactersRegex, getLocale, getLocaleWithCountryAndVariant, getPatternRules, getPostDisambiguationChunker, getRelevantLanguageModelCapableRules, getRelevantRemoteRules, getRemoteEnhancedRules, getRuleFileNames, getRulePriority, getSentenceTokenizer, getShortCodeWithCountryAndVariant, getSynthesizer, getTagger, getTranslatedName, getUnifier, getUnifierConfiguration, getVariant, getWordTokenizer, hashCode, hasNGramFalseFriendRule, hasVariant, initLanguageModel, isExternal, isHiddenFromGui, isSpellcheckOnlyLanguage, isVariant, mergeSuggestions, setChunker, setDisambiguator, setPostDisambiguationChunker, setSentenceTokenizer, setSynthesizer, setTagger, setWordTokenizer, toString

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

- Constructor Detail
  - French
```
public French()
```
- Method Detail
  - createDefaultSentenceTokenizer
```
public SentenceTokenizer createDefaultSentenceTokenizer()
```
    Description copied from class: Language
    
    Creates language specific sentence tokenizer. This function will be called each time in Language.getSentenceTokenizer() if sentence tokenizer is not set.
    
    Overrides:
    
    createDefaultSentenceTokenizer in class Language
  - getName
```
public String getName()
```
    Description copied from class: Language
    
    Get this language's name in English, e.g. English or German (Germany).
    
    Specified by:
    
    getName in class Language
    
    Returns:
    
    language name
  - getShortCode
```
public String getShortCode()
```
    Description copied from class: Language
    
    Get this language's character code, e.g. en for English. For most languages this is a two-letter code according to ISO 639-1, but for those languages that don't have a two-letter code, a three-letter code according to ISO 639-2 is returned. The country parameter (e.g. "US"), if any, is not returned.
    
    Specified by:
    
    getShortCode in class Language
  - 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).
    
    Specified by:
    
    getCountries in class Language
    
    Returns:
    
    String[] - array of country options for the language.
  - getDefaultLanguageVariant
```
public Language getDefaultLanguageVariant()
```
    Description copied from class: Language
    
    Languages that have country variants need to overwrite this to select their most common variant.
    
    Overrides:
    
    getDefaultLanguageVariant in class Language
    
    Returns:
    
    default country variant
  - createDefaultTagger
```
@NotNull
public Tagger createDefaultTagger()
```
    Description copied from class: Language
    
    Creates language specific part-of-speech tagger. The tagger must not be null, but it can be a trivial pseudo-tagger that only assigns null tags. This function will be called each time in Language.getTagger() ()} if tagger is not set.
    
    Overrides:
    
    createDefaultTagger in class Language
  - createDefaultSynthesizer
```
@Nullable
public Synthesizer createDefaultSynthesizer()
```
    Description copied from class: Language
    
    Creates language specific part-of-speech synthesizer. This function will be called each time in Language.getSynthesizer() if synthesizer is not set.
    
    Overrides:
    
    createDefaultSynthesizer in class Language
  - createDefaultWordTokenizer
```
public Tokenizer createDefaultWordTokenizer()
```
    Description copied from class: Language
    
    Creates language specific word tokenizer. This function will be called each time in Language.getWordTokenizer() if word tokenizer is not set.
    
    Overrides:
    
    createDefaultWordTokenizer in class Language
  - createDefaultDisambiguator
```
public Disambiguator createDefaultDisambiguator()
```
    Description copied from class: Language
    
    Creates language specific disambiguator. This function will be called each time in Language.getDisambiguator() if disambiguator is not set.
    
    Overrides:
    
    createDefaultDisambiguator in class Language
  - getMaintainers
```
public Contributor[] getMaintainers()
```
    Description copied from class: Language
    
    Get the name(s) of the maintainer(s) for this language or null.
    
    Specified by:
    
    getMaintainers in class Language
  - createDefaultSpellingRule
```
public SpellingCheckRule createDefaultSpellingRule(ResourceBundle messages)
                                            throws IOException
```
    Overrides:
    
    createDefaultSpellingRule in class Language
    
    Throws:
    
    IOException
  - 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.
    
    Specified by:
    
    getRelevantRules in class Language
    
    Throws:
    
    IOException
  - getRelevantRulesGlobalConfig
```
public List<Rule> getRelevantRulesGlobalConfig(ResourceBundle messages,
                                               GlobalConfig globalConfig,
                                               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:
    
    getRelevantRulesGlobalConfig in class Language
    
    Throws:
    
    IOException
  - getRelevantLanguageModelRules
```
public List<Rule> getRelevantLanguageModelRules(ResourceBundle messages,
                                                LanguageModel languageModel,
                                                UserConfig userConfig)
                                         throws IOException
```
    Description copied from class: Language
    
    Get a list of rules that require a LanguageModel. Returns an empty list for languages that don't have such rules.
    
    Overrides:
    
    getRelevantLanguageModelRules in class Language
    
    Throws:
    
    IOException
    
    Since:
    
    3.1
  - getLanguageModel
```
public LanguageModel getLanguageModel(File indexDir)
                               throws IOException
```
    Overrides:
    
    getLanguageModel in class Language
    
    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:
    
    3.1
  - getOpeningDoubleQuote
```
public String getOpeningDoubleQuote()
```
    Overrides:
    
    getOpeningDoubleQuote in class Language
    
    Since:
    
    5.1
  - getClosingDoubleQuote
```
public String getClosingDoubleQuote()
```
    Overrides:
    
    getClosingDoubleQuote in class Language
    
    Since:
    
    5.1
  - getOpeningSingleQuote
```
public String getOpeningSingleQuote()
```
    Overrides:
    
    getOpeningSingleQuote in class Language
    
    Since:
    
    5.1
  - getClosingSingleQuote
```
public String getClosingSingleQuote()
```
    Overrides:
    
    getClosingSingleQuote in class Language
    
    Since:
    
    5.1
  - isAdvancedTypographyEnabled
```
public boolean isAdvancedTypographyEnabled()
```
    Overrides:
    
    isAdvancedTypographyEnabled in class Language
    
    Since:
    
    5.1
  - toAdvancedTypography
```
public String toAdvancedTypography(String input)
```
    Overrides:
    
    toAdvancedTypography in class Language
  - close
```
public void close()
           throws Exception
```
    Closes the language model, if any.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
    
    Since:
    
    3.1
  - getMaintainedState
```
public LanguageMaintainedState getMaintainedState()
```
    Description copied from class: Language
    
    Information about whether the support for this language in LanguageTool is actively maintained. If not, the user interface might show a warning.
    
    Overrides:
    
    getMaintainedState in class Language
  - 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 Language
  - hasMinMatchesRules
```
public boolean hasMinMatchesRules()
```
    Overrides:
    
    hasMinMatchesRules in class Language
  - adaptSuggestions
```
public List<RuleMatch> adaptSuggestions(List<RuleMatch> ruleMatches,
                                        Set<String> enabledRules)
```
    Overrides:
    
    adaptSuggestions in class Language

Class French

Constructor Summary

Method Summary

Methods inherited from class org.languagetool.Language

Methods inherited from class java.lang.Object

Constructor Detail

French

Method Detail

createDefaultSentenceTokenizer

getName

getShortCode

getCountries

getDefaultLanguageVariant

createDefaultTagger

createDefaultSynthesizer

createDefaultWordTokenizer

createDefaultDisambiguator

getMaintainers

createDefaultSpellingRule

getRelevantRules

getRelevantRulesGlobalConfig

getRelevantLanguageModelRules

getLanguageModel

getOpeningDoubleQuote

getClosingDoubleQuote

getOpeningSingleQuote

getClosingSingleQuote

isAdvancedTypographyEnabled

toAdvancedTypography

close

getMaintainedState

getPriorityForId

hasMinMatchesRules

adaptSuggestions