All Classes

Class	Description
AbstractCompoundRule	Checks that compounds (if in the list) are not written as separate words.
AbstractDashRule	Another use of the compounds file -- check for compounds written with dashes instead of hyphens (for example, Rabka — Zdrój).
AbstractDateCheckFilter	Accepts rule matches if a date doesn't match the accompanying weekday, e.g.
AbstractDisambiguator	Abstract Disambiguator class to provide default (empty) implementation for Disambiguator.preDisambiguate(AnalyzedSentence).
AbstractFillerWordsRule	A rule that gives hints about the use of filler words.
AbstractFutureDateFilter	Checks if a given date is in the future Used for mismatch detection between verb tense and a given date
AbstractNewYearDateFilter	Accepts rule matches if we are in the first days of a new year and the user may have entered a date with the old year (but not a date in December).
AbstractPatternRule	An Abstract Pattern Rule that describes a pattern of words or part-of-speech tags used for PatternRule and DisambiguationPatternRule.
AbstractPatternRulePerformer
AbstractPunctuationCheckRule	A rule that matches "..", "::", "-," but not "...", "!..", "?!!", ",-" etc.
AbstractSimpleReplaceRule	A rule that matches words which should not be used and suggests correct ones instead.
AbstractSimpleReplaceRule2	A rule that matches words which should not be used and suggests correct ones instead.
AbstractSpaceBeforeRule	An abstract rule that checks if there is a missing space before some conjunctions.
AbstractStyleRepeatedWordRule	An abstract rule checks the appearance of same words in a sentence or in two consecutive sentences.
AbstractUnitConversionRule	Base class providing support for detecting, parsing and converting between measurements in different units
AbstractUnitConversionRule.Message
AbstractWordCoherencyRule	A rule that matches words for which two different spellings are used throughout the document.
AdvancedWordRepeatRule	Rule for detecting same words in the sentence but not just in a row.
AnalyzedSentence	A sentence that has been tokenized and analyzed.
AnalyzedToken	A word (or punctuation, or whitespace) and its analysis (part-of-speech tag, lemma)
AnalyzedTokenReadings	An array of AnalyzedTokens used to store multiple POS tags and lemmas for a given single token.
AnnotatedText	A text with markup and with a mapping so error positions will refer to the original position that includes the markup, even though only the plain text parts are checked.
AnnotatedText.MetaDataKey
AnnotatedTextBuilder	Use this builder to create input of text with markup for LanguageTool, so that it can check only the plain text parts and ignore the markup, yet still calculate the positions of errors so that they refer to the complete text, including markup.
ApiCleanupNeeded	An internal marker for places in the source where the API would need to be cleaned up.
BaseLanguageModel	The algorithm of a language model, independent of the way data is stored (see sub classes for that).
BaseSynthesizer
BaseTagger	Base tagger using Morfologik binary dictionaries.
BitextPatternRule	A bitext pattern rule class.
BitextPatternRuleLoader	Loads PatternRules from an XML file.
BitextReader	Interface for classes that implement reading from bitext files, such as translation memory files, glossary files, aligned text...
BitextRule	Abstract bitext rule class.
CachingWordListLoader	Helper to load text files from classpath.
CaseConversionHelper
Categories	Pre-defined rule categories.
Category	A rule's category.
Category.Location
CategoryId	Identifier for a category.
CategoryIds	Category ids.
ChunkArray<T>
Chunker	Assign chunks (i.e.
ChunkTag	The name of a chunk.
Classifier
CleanOverlappingFilter
CombiningTagger	Tags a word using two taggers, combining their results.
CommaWhitespaceRule	A rule that matches periods, commas and closing parenthesis preceded by whitespace and opening parenthesis followed by whitespace.
CommonWords	Information about common words - use as a fallback if language identification yields low confidence.
CompoundAwareHunspellRule	A spell checker that combines Hunspell und Morfologik spell checking to support compound words and offer fast suggestions for some misspelled compound words.
CompoundRuleData	Data about words that are compounds and should thus not be written as separate words.
CompoundWordTokenizer	Interface for components that take compound words and split them into their parts.
ConfusionPair	Two words that can easily be confused - for internal use only.
ConfusionProbabilityRule	LanguageTool's homophone confusion check that uses ngram lookups to decide which word in a confusion set (from confusion_sets.txt) suits best.
ConfusionSet	Words that can easily be confused - for internal use only.
ConfusionSetLoader	Loads a confusion set from a plain text file (UTF-8).
ConfusionString	A string in a ConfusionPair - for internal use only.
ContextTools	Helper class to mark errors in text.
Contributor	A person that contributed rules or code to LanguageTool.
CorrectExample	A text, typically a sentence, that doesn't contain an error, at least not one for a specific rule.
DateRangeChecker	Checks whether the date range is valid, i.e., that the starting date happens before the end date.
DefaultResourceDataBroker	Responsible for getting any items from the grammar checker's resource directories.
DemoDisambiguator	Trivial disambiguator.
DemoRule	A simple demo rule as an example for how to implement your own Java-based rule in LanguageTool.
DemoTagger	A trivial tagger that does nothing than assign null tags to words.
DetailedDamerauLevenstheinDistance
DetailedDamerauLevenstheinDistance.Delete
DetailedDamerauLevenstheinDistance.Distance
DetailedDamerauLevenstheinDistance.EditOperation
DetailedDamerauLevenstheinDistance.Insert
DetailedDamerauLevenstheinDistance.Replace
DetailedDamerauLevenstheinDistance.Transpose
DetectedLanguage
Dictionary
DictionaryMatchFilter
DifferentLengthRule	Checks if the translation has a really different length than the source (smaller than 30% or longer by 250%).
DifferentPunctuationRule	Checks if the translation has the same ending punctuation as the source.
DisambiguatedExample	Disambiguated example.
DisambiguationPatternRule	A Rule that describes a pattern of words or part-of-speech tags used for disambiguation.
DisambiguationPatternRule.DisambiguatorAction	Possible disambiguator actions.
DisambiguationRuleLoader	Loads DisambiguationPatternRules from a disambiguation rules XML file.
Disambiguator	Disambiguator interface.
DoublePunctuationRule	A rule that matches ".." (but not "..." etc) and ",,".
EditDistance
EditDistance.DistanceAlgorithm
EmptyLineRule	A rule that checks for empty lines.
ErrorRateTooHighException
ErrorTriggeringExample	A text, typically a sentence, that doesn't contain an error, but still leads to an error.
Example	Helper class to create error examples.
ExampleSentence
Experimental	An experimental feature that may change without warning in future versions.
FalseFriendPatternRule	A pattern rule for finding false friends.
FalseFriendRuleLoader	Loads PatternRules from a false friends XML file.
FalseFriendsAsBitextLoader	Loads the false friend rules as bitext pattern rules.
GenericUnpairedBracketsRule	Rule that finds unpaired quotes, brackets etc.
GlobalConfig
GoogleTokenUtil
Hunspell	The simple hunspell library frontend which takes care of creating and singleton'ing the library instance (no need to load it more than once per process).
HunspellLibrary	Functions from $hunspell/src/hunspell/hunspell.h The Hunspell java bindings are licensed under the same terms as Hunspell itself (GPL/LGPL/MPL tri-license), see the file COPYING.txt in the root of the distribution for the exact terms.
HunspellNoSuggestionRule	Like HunspellRule, but does not offer suggestions for incorrect words as that is very slow with Hunspell.
HunspellRule	A hunspell-based spellchecking-rule.
IncorrectBitextExample	A text, typically a pair of sentences that contains an error.
IncorrectExample	A text, typically a sentence, that contains an error.
InterruptibleCharSequence	CharSequence that noticed thread interrupts -- as might be necessary to recover from a loose regex on unexpected challenging input.
ITSIssueType	Some constants for Localization Quality Issue Type from the Internationalization Tag Set (ITS) Version 2.0.
JLanguageTool	The main class used for checking text against different rules: built-in Java rules (for English: a vs.
JLanguageTool.Mode
JLanguageTool.ParagraphHandling	Constants for correct paragraph-rule handling.
JnaTools	JNA helper tools.
Language	Base class for any supported language (English, German, etc).
LanguageBuilder	Create a language by specifying the language's XML rule file.
LanguageDependentFilter
LanguageIdentifier	Identify the language of a text.
LanguageMaintainedState	Information about whether a language in LanguageTool is actively maintained.
LanguageModel	A language model that provides information about ngram probabilities.
LanguageModelUtils
Languages	Helper methods to list all supported languages and to get language objects by their name or language code etc.
LinguServices	Dummy class for UserConfig has to be overridden by concrete linguistic service e.g.
LongParagraphRule	A rule that warns on long paragraphs.
LongSentenceRule	A rule that warns on long sentences.
LuceneLanguageModel	Like LuceneSingleIndexLanguageModel, but can merge the results of lookups in several independent indexes to one result.
LuceneSingleIndexLanguageModel	Information about ngram occurrences, taken from Lucene indexes (one index per ngram level).
LuceneSingleIndexLanguageModel.LuceneSearcher
ManualSynthesizer	A synthesizer that reads the inflected form and POS information from a plain (UTF-8) text file.
ManualTagger	A tagger that reads the POS information from a plain (UTF-8) text file.
Match	A Match is the configuration of an algorithm used to match AnalyzedTokenReadingss.
Match.CaseConversion	Possible string case conversions.
Match.IncludeRange
MatchState	The state of a matching process.
Matrix
MockLanguageModel	Produces zero probability for any passed text.
MorfologikMultiSpeller	Morfologik speller that merges results from binary (.dict) and plain text (.txt) dictionaries.
MorfologikSpeller	Morfologik-based spell checker.
MorfologikSpellerRule
MorfologikTagger	Tags a word using a Morfologik binary dictionary.
MultiKeyProperties	A very simple property-style configuration.
MultiLanguageModel	Combines the results of several LanguageModels.
MultipleWhitespaceRule	Check if there is duplicated whitespace in a sentence.
MultiThreadedJLanguageTool	A variant of JLanguageTool that uses several threads for rule matching.
MultiWordChunker	Multiword tagger-chunker.
MultiWordChunker2	Multiword tagger-chunker.
NeuralNetworkRule
NeuralNetworkRuleCreator
NgramProbabilityRule	LanguageTool's probability check that uses ngram lookups to decide if an ngram of the input text is so rare in our ngram index that it should be considered an error.
NoopChunker	No-op chunker.
NoopDisambiguator
NoopLanguage	A language that is part of languagetool-core but that hasn't any rules.
OpenNMTRule	Queries an OpenNMT server started like this: th tools/rest_translation_server.lua -replace_unk -model ...
OutputStreamLogger
ParagraphRepeatBeginningRule	Check if to paragraphs begin with the same word.
PartialPosTagFilter	Filters rule matches so that only matches are kept where a part of the token has a given POS tag.
PasswordAuthenticator	Authenticator that extracts username and password from URL, e.g.
PatternRule	A Rule that describes a language error as a simple pattern of words or of part-of-speech tags.
PatternRuleBuilderHelper
PatternRuleHandler
PatternRuleId	A PatternRule's id with an optional sub-id.
PatternRuleLoader	Loads PatternRules from an XML file.
PatternRuleMatcher	Matches a pattern rule against text.
PatternRuleXmlCreator	Makes XML definition of rules accessible as strings.
PatternToken	A part of a pattern, represents the 'token' element of the grammar.xml.
PatternToken.PosToken
PatternTokenBuilder	Helper to build PatternTokens.
PatternTokenMatcher
Probability	Probability, but doesn't check for a range of 0 to 1.
PunctuationMarkAtParagraphEnd	A rule that checks for a punctuation mark at the end of a paragraph.
ReadabilityRule	A rule that checks the readability of English text (using the Flesch-Reading-Ease Formula) If tooEasyTest == true, the rule tests if paragraph level > level (readability is too easy) If tooEasyTest == false, the rule tests if paragraph level < level (readability is too difficult)
RegexPatternRule	Matches 'regexp' elements from XML rules against sentences.
ResourceBundleWithFallback	A resource bundle that uses its fallback resource bundle if the value from the original bundle is null or empty.
ResourceDataBroker	Is responsible for getting the necessary resources for the grammar checker library.
ResultCache	A cache to speed up text checking for use cases where sentences are checked more than once.
Rule	Abstract rule class.
RuleCheckTimeMessage
RuleErrorNotification
RuleFilenameException	Thrown if external rule filename doesn't match the required format.
RuleFilter	Filter rule matches after a PatternRule has matched already.
RuleFilterCreator	Create a RuleFilter.
RuleFilterEvaluator	Evaluates a RuleFilter.
RuleLogger
RuleLoggerManager
RuleLoggerMessage
RuleMatch	Information about an error rule that matches text and the position of the match.
RuleMatch.Type	Unlike Category, this is specific to a RuleMatch, not to a rule.
RuleMatchAsXmlSerializer	Deprecated. don't use for new use cases, the only place this should still be used is for the API mode of the command-line client (deprecated since 3.5)
RuleMatcher
RuleMatchesAsJsonSerializer	Write rule matches and some meta information as JSON.
RuleMatchFilter	Filter rule matches.
RuleMatchListener
RuleWithLanguage
RuleWithMaxFilter	Filter rule matches so that only the longest match is kept from overlapping matches with the same rule that contains tokens with maxOccurrence > 1.
SameRuleGroupFilter	Filter rule matches so that only the first match is kept from overlapping matches with the same rule group (actually: the same id).
SameTranslationRule	Checks if the translation for segments that have more than two words is different.
ScoredConfusionSet	Words that can easily be confused - for internal use only.
ScoredConfusionSetLoader	Loads a confusion set from a plain text file (UTF-8).
SentenceTokenizer	Tokenizes text into sentences.
SentenceWhitespaceRule	Checks that there's whitespace between sentences.
ShortDescriptionProvider	Provide short (~ up to 30 characters) descriptions for words.
ShortenedYearRangeChecker	Checks whether a shortened year range (such as '1998-92') is valid, i.e., that the starting date happens before the end date.
SimpleReplaceDataLoader	Load replacement data from a UTF-8 file.
SimpleSentenceTokenizer	A very simple sentence tokenizer that splits on [.!?…] followed by whitespace or an uppercase letter.
SingleLayerClassifier
Soros
SpellingCheckRule	An abstract rule for spellchecking rules.
SRXSentenceTokenizer	Class to tokenize sentences using rules from an SRX file.
StringPair	A convenience class to work with bitext strings.
StringTools	Tools for working with strings.
StringTools.ApiPrintMode	Constants for printing XML rule matches.
SuggestedReplacement
Suggestion
SuggestionChangesExperiment
SuggestionFilter	Filter suggestions against a rule.
SuggestionsChanges	Helper class for SuggestionChangesTest, tracks experiment configuration and results Rules should use getInstance() != null -> getInstance().getCurrentExperiment() in constructors to fetch relevant parameters Use isRunningExperiment if no parameters are needed
SuggestionsOrderer
SuggestionsOrdererConfig
SuggestionsOrdererFeatureExtractor	Computes features that can be stored for training a model to rank suggestions, or when using the same model for prediction Used directly by SuggestionChangesTest for the former, and as a superclass for the latter
SuggestionsOrdererGSoC	Deprecated.
SuggestionSorter	Deprecated. still work in progress
SuggestionsRanker	Implementing classes must provide confidence values with the SuggestedReplacement objects returned by orderSuggestions
SuggestionStage
SuggestItem
SymbolLocator	Helper class for GenericUnpairedBracketsRule to identify symbols indexed with integers.
SymSpell
SymSpell.Verbosity
SymSpellRule	spell checking using SymSpell algorithm, implementation from https://github.com/Lundez/JavaSymSpell in org.languagetool.rules.spelling.symspell.implementation potential faster alternative to Morfologik, especially in generating suggestions
Synthesizer	Part-of-speech synthesizer interface.
SynthesizerTools
TabBitextReader	Reader of simple tab-delimited bilingual files.
TaggedWord	Result of WordTagger.
Tagger	The part-of-speech tagger interface, whose implementations are usually language-dependent.
TextLevelRule	A rule that considers the complete text, not just one sentence after the other.
Tokenizer	Interface for classes that tokenize text into smaller units.
Tools
TwoLayerClassifier
Unifier	Implements unification of features over tokens.
UnifierConfiguration
UnsyncStack<E>	Implements unsynchronized stack (contrary to default Java Stack, this one is based on ArrayList).
UppercaseSentenceStartRule	Checks that a sentence starts with an uppercase letter.
UserConfig	User-specific configuration.
WhiteSpaceAtBeginOfParagraph	A rule that checks for WhiteSpaces at the begin of a paragraph
WhiteSpaceBeforeParagraphEnd	A rule that checks for a whitespace at the end of a paragraph
WhitespaceBeforePunctuationRule	A rule that matches several punctuation signs such as : ; and % preceded by whitespace.
WhitespaceCheckFilter
Word2VecModel
WordCoherencyDataLoader	Loads word variations words from a UTF-8 file.
WordFastTMReader	Reader of WordFast Translation Memory text files.
WordRepeatBeginningRule	Check if three successive sentences begin with the same word, e.g.
WordRepeatRule	Check if a word is repeated, e.g.
WordTagger	Find the potential part-of-speech tags (POS tags) for a word.
WordTokenizer	Tokenizes a sentence into words.
WrongWordInContextRule	Check if there is a confusion of two words (which might have a similar spelling) depending on the context.
XGBoostSuggestionsOrderer
XmlRuleDisambiguator	Rule-based disambiguator.
XMLRuleHandler	XML rule handler that loads rules from XML and throws exceptions on errors and warnings.
XMLValidator	Validate XML files with a given DTD or XML Schema (XSD).
YMDDateHelper