Package 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

  • Field Details

    • abTestEnabled

      private static boolean abTestEnabled

    • userSpecificSpellerWords

      private final List<String> userSpecificSpellerWords

    • acceptedPhrases

      private final Set<String> acceptedPhrases

    • userSpecificRules

      private final List<Rule> userSpecificRules

    • maxSpellingSuggestions

      private final int maxSpellingSuggestions

    • userDictCacheSize

      private final Long userDictCacheSize

    • userDictName

      private final String userDictName

    • premiumUid

      private final Long premiumUid

    • configurableRuleValues

      private final Map<String,Object[]> configurableRuleValues

    • linguServices

      private final LinguServices linguServices

    • filterDictionaryMatches

      private final boolean filterDictionaryMatches

    • hidePremiumMatches

      private final boolean hidePremiumMatches

    • textSessionId

      private final Long textSessionId

    • abTest

      private final List<String> abTest

    • preferredLanguages

      private final String preferredLanguages

    • trustedSource

      private boolean trustedSource

    • optInThirdPartyAI

      private boolean optInThirdPartyAI

    • isPremium

      private boolean isPremium

  • Constructor Details

    • UserConfig

      public UserConfig()

    • UserConfig

      public UserConfig(List<String> userSpecificSpellerWords)

    • UserConfig

      public UserConfig(Map<String,Object[]> ruleValues)

    • UserConfig

      public UserConfig(Map<String,Object[]> ruleValues, LinguServices linguServices)

    • UserConfig

      public UserConfig(List<String> userSpecificSpellerWords, Map<String,Object[]> ruleValues)

    • UserConfig

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

    • UserConfig

      public UserConfig(List<String> userSpecificSpellerWords, List<Rule> userSpecificRules, Map<String,Object[]> 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)

    • UserConfig

      public UserConfig(List<String> userSpecificSpellerWords, List<Rule> userSpecificRules, Map<String,Object[]> 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, boolean trustedSource, boolean optInThirdPartyAI, boolean isPremium)

  • Method Details

    • enableABTests

      public static void enableABTests()

    • hasABTestsEnabled

      public static boolean hasABTestsEnabled()

    • removeAllButMainLanguagesAndSort

      private String removeAllButMainLanguagesAndSort(List<String> preferredLanguages)

    • getAcceptedWords

      @NotNull public List<String> getAcceptedWords()

    • buildAcceptedPhrases

      private Set<String> buildAcceptedPhrases()

    • getAcceptedPhrases

      @NotNull public Set<String> getAcceptedPhrases()

    • getRules

      @NotNull public List<Rule> getRules()
      Since:
      5.7

    • getMaxSpellingSuggestions

      public int getMaxSpellingSuggestions()

    • getConfigValues

      public Map<String,Object[]> getConfigValues()

    • insertConfigValues

      public void insertConfigValues(Map<String,Object[]> ruleValues)

    • getConfigValueByID

      public Object[] 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: