Class BlackListRule


  • public class BlackListRule
    extends org.languagetool.rules.patterns.PatternRule
    A Blacklist Check pattern rule class. A BlackListRule describes a language error where a blacklisted target term is found in the target.
    Author:
    jimh
    • Field Summary

      • Fields inherited from class org.languagetool.rules.patterns.AbstractPatternRule

        antiPatterns, endPositionCorrection, filter, filterArgs, language, message, patternTokens, sentStart, sourceFile, startPositionCorrection, subId, suggestionMatches, suggestionMatchesOutMsg, suggestionsOutMsg, testUnification, type
      • Fields inherited from class org.languagetool.rules.Rule

        messages
    • Constructor Summary

      Constructors 
      Constructor Description
      BlackListRule​(String id, org.languagetool.Language language, List<org.languagetool.rules.patterns.PatternToken> patternTokens, String description, String message, String shortMessage)  
      BlackListRule​(org.languagetool.rules.patterns.PatternRule trgPattern, String shortMessage)  
    • Method Summary

      • Methods inherited from class org.languagetool.rules.patterns.PatternRule

        estimateContextForSureMatch, getShortMessage, match, toPatternString, toXML
      • Methods inherited from class org.languagetool.rules.patterns.AbstractTokenBasedRule

        canBeIgnoredFor
      • Methods inherited from class org.languagetool.rules.patterns.AbstractPatternRule

        addSuggestionMatch, addSuggestionMatchOutMsg, getAntiPatterns, getDescription, getEndPositionCorrection, getFilter, getFilterArguments, getFullId, getId, getLanguage, getMessage, getPatternRuleId, getPatternTokens, getSourceFile, getStartPositionCorrection, getSubId, getSuggestionsOutMsg, getType, isAdjustSuggestionCase, isGetUnified, isGroupsOrUnification, isSentStart, isTestUnification, setAdjustSuggestionCase, setAntiPatterns, setEndPositionCorrection, setFilter, setFilterArguments, setMessage, setStartPositionCorrection, setSubId, setType, supportsLanguage, toString
      • Methods inherited from class org.languagetool.rules.Rule

        addExamplePair, addTags, cacheAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getTags, getUrl, hasConfigurableValue, hasTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setTags, setUrl, toRuleMatchArray, useInOffice
    • Constructor Detail

      • BlackListRule

        public BlackListRule​(String id,
                             org.languagetool.Language language,
                             List<org.languagetool.rules.patterns.PatternToken> patternTokens,
                             String description,
                             String message,
                             String shortMessage)
      • BlackListRule

        public BlackListRule​(org.languagetool.rules.patterns.PatternRule trgPattern,
                             String shortMessage)