Class LongParagraphRule


  • public class LongParagraphRule
    extends TextLevelRule
    A rule that warns on long paragraphs. Note that this rule is off by default.
    Since:
    4.2
    • Method Detail

      • 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
      • 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
      • getDefaultValue

        public int getDefaultValue()
        Description copied from class: Rule
        Overwrite this to get a default Integer value by option panel
        Overrides:
        getDefaultValue in class Rule
      • hasConfigurableValue

        public boolean hasConfigurableValue()
        Description copied from class: Rule
        Overwrite this to return true, if a value may be configured by option panel
        Overrides:
        hasConfigurableValue in class Rule
      • getMinConfigurableValue

        public int getMinConfigurableValue()
        Description copied from class: Rule
        Overwrite this to define the minimum of a configurable value
        Overrides:
        getMinConfigurableValue in class Rule
      • getMaxConfigurableValue

        public int getMaxConfigurableValue()
        Description copied from class: Rule
        Overwrite this to define the maximum of a configurable value
        Overrides:
        getMaxConfigurableValue in class Rule
      • getConfigureText

        public String getConfigureText()
        Description copied from class: Rule
        Overwrite this to define the Text in the option panel for the configurable value
        Overrides:
        getConfigureText in class Rule
      • getMessage

        public String getMessage()
      • minToCheckParagraph

        public int minToCheckParagraph()
        Description copied from class: TextLevelRule
        Gives back the minimum number of paragraphs to check to give back a correct result. Only used by LO office extension.
        • n == -1 --> need to check full text (use only if really needed / bad performance) examples: AbstractWordCoherencyRule, GenericUnpairedBracketsRule, ...
        • n == 0 --> need only to check the current paragraph examples: MultipleWhitespaceRule, LongParagraphRule, ...
        • n >= 1 --> need only to check n paragraphs around the current paragraph examples: ParagraphRepeatBeginningRule (n == 1), WordRepeatBeginningRule (n == 2), ...
        Specified by:
        minToCheckParagraph in class TextLevelRule