Class DemoRule


  • public class DemoRule
    extends Rule
    A simple demo rule as an example for how to implement your own Java-based rule in LanguageTool. Simple walks over the text and prints the words and their analysis.

    To activate this rule, add it to getRelevantRules() in e.g. English.java.

    This rule works on sentences, extend TextLevelRule instead to work on the complete text.

    • Constructor Detail

      • DemoRule

        public DemoRule()
    • Method Detail

      • getId

        public String getId()
        Description copied from class: Rule
        A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.
        Specified by:
        getId in class Rule
      • getDescription

        public String getDescription()
        Description copied from class: Rule
        A short description of the error this rule can detect, usually in the language of the text that is checked.
        Specified by:
        getDescription in class Rule
      • match

        public RuleMatch[] match​(AnalyzedSentence sentence)
                          throws IOException
        Description copied from class: Rule
        Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different than the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example).
        Specified by:
        match in class Rule
        Parameters:
        sentence - a pre-analyzed sentence
        Returns:
        an array of RuleMatch objects
        Throws:
        IOException