org.languagetool

Class UserConfig

java.lang.Object

org.languagetool.UserConfig

public class UserConfig
extends Object

User-specific configuration. So far, this contains a list of words and a settings map.

Since:

4.2

Constructor Summary

Constructors

Constructor and Description
UserConfig()
UserConfig(List<String> userSpecificSpellerWords)
UserConfig(List<String> userSpecificSpellerWords, List<Rule> userSpecificRules, Map<String,Integer> ruleValues, int maxSpellingSuggestions, Long premiumUid, String userDictName, Long userDictCacheSize, LinguServices linguServices, boolean filterDictionaryMatches, List<String> abTest, Long textSessionId, boolean hidePremiumMatches, List<String> preferredLanguages)
UserConfig(List<String> userSpecificSpellerWords, Map<String,Integer> ruleValues)
UserConfig(List<String> userSpecificSpellerWords, Map<String,Integer> ruleValues, int maxSpellingSuggestions, Long premiumUid, String userDictName, Long userDictCacheSize, LinguServices linguServices)
UserConfig(Map<String,Integer> ruleValues)
UserConfig(Map<String,Integer> ruleValues, LinguServices linguServices)

Method Summary

Modifier and Type	Method and Description
static void	enableABTests()
boolean	equals(Object o)
boolean	filterDictionaryMatches()
List<String>	getAbTest()
Set<String>	getAcceptedPhrases()
List<String>	getAcceptedWords()
int	getConfigValueByID(String ruleID)
Map<String,Integer>	getConfigValues()
boolean	getHidePremiumMatches()
LinguServices	getLinguServices()
int	getMaxSpellingSuggestions()
List<String>	getPreferredLanguages() This may not contain the full preferredLanguages list as it's intended to only be used with ForeignLanguageChecker
Long	getPremiumUid()
List<Rule>	getRules()
Long	getTextSessionId()
Long	getUserDictCacheSize() for speedup, certain users custom dictionaries are cached.
String	getUserDictName()
static boolean	hasABTestsEnabled()
int	hashCode()
boolean	hasLinguServices()
void	insertConfigValues(Map<String,Integer> ruleValues)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfig

public UserConfig()

UserConfig

public UserConfig(List<String> userSpecificSpellerWords)

UserConfig

public UserConfig(Map<String,Integer> ruleValues)

UserConfig

public UserConfig(Map<String,Integer> ruleValues,
                  LinguServices linguServices)

UserConfig

public UserConfig(List<String> userSpecificSpellerWords,
                  Map<String,Integer> ruleValues)

UserConfig

public UserConfig(List<String> userSpecificSpellerWords,
                  Map<String,Integer> ruleValues,
                  int maxSpellingSuggestions,
                  Long premiumUid,
                  String userDictName,
                  Long userDictCacheSize,
                  LinguServices linguServices)

UserConfig

public UserConfig(List<String> userSpecificSpellerWords,
                  List<Rule> userSpecificRules,
                  Map<String,Integer> ruleValues,
                  int maxSpellingSuggestions,
                  Long premiumUid,
                  String userDictName,
                  Long userDictCacheSize,
                  LinguServices linguServices,
                  boolean filterDictionaryMatches,
                  @Nullable
                  List<String> abTest,
                  @Nullable
                  Long textSessionId,
                  boolean hidePremiumMatches,
                  List<String> preferredLanguages)

Method Detail

enableABTests

public static void enableABTests()

hasABTestsEnabled

public static boolean hasABTestsEnabled()

getAcceptedWords

@NotNull
public List<String> getAcceptedWords()

getAcceptedPhrases

@NotNull
public Set<String> getAcceptedPhrases()

getRules

@NotNull
public List<Rule> getRules()

Since:

5.7

getMaxSpellingSuggestions

public int getMaxSpellingSuggestions()

getConfigValues

public Map<String,Integer> getConfigValues()

insertConfigValues

public void insertConfigValues(Map<String,Integer> ruleValues)

getConfigValueByID

public int getConfigValueByID(String ruleID)

hasLinguServices

public boolean hasLinguServices()

getLinguServices

public LinguServices getLinguServices()

getUserDictCacheSize

public Long getUserDictCacheSize()

for speedup, certain users custom dictionaries are cached. Null if disabled, else max. number of words in cache

Since:

4.3

getUserDictName

public String getUserDictName()

Since:

4.3

getPremiumUid

public Long getPremiumUid()

Since:

4.3

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getTextSessionId

public Long getTextSessionId()

getAbTest

public List<String> getAbTest()

filterDictionaryMatches

public boolean filterDictionaryMatches()

getHidePremiumMatches

public boolean getHidePremiumMatches()

Since:

5.5

getPreferredLanguages

@NotNull
public List<String> getPreferredLanguages()

This may not contain the full preferredLanguages list as it's intended to only be used with ForeignLanguageChecker

Returns: