Class CheckFilter

  • All Implemented Interfaces:
    com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
    Direct Known Subclasses:
    IdentCheckFilter

    public class CheckFilter
    extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
    Base class for checks that act as a filter for a single child.
    Author:
    Phillip Webb
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

        com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions
    • Constructor Summary

      Constructors 
      Constructor Description
      CheckFilter()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void beginTree​(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)  
      void finishLocalSetup()  
      void finishTree​(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)  
      int[] getAcceptableTokens()  
      int[] getDefaultTokens()  
      int[] getRequiredTokens()  
      SortedSet<com.puppycrawl.tools.checkstyle.api.Violation> getViolations()  
      boolean isCommentNodesRequired()  
      void leaveToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)  
      void setupChild​(com.puppycrawl.tools.checkstyle.api.Configuration childConf)  
      void visitToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)  
      • Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

        clearViolations, destroy, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, log, log, log, setFileContents, setTabWidth, setTokens
      • Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

        getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
      • Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

        configure, contextualize, getConfiguration
    • Constructor Detail

      • CheckFilter

        public CheckFilter()
    • Method Detail

      • finishLocalSetup

        public void finishLocalSetup()
        Overrides:
        finishLocalSetup in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
      • setupChild

        public void setupChild​(com.puppycrawl.tools.checkstyle.api.Configuration childConf)
                        throws com.puppycrawl.tools.checkstyle.api.CheckstyleException
        Overrides:
        setupChild in class com.puppycrawl.tools.checkstyle.api.AutomaticBean
        Throws:
        com.puppycrawl.tools.checkstyle.api.CheckstyleException
      • getDefaultTokens

        public int[] getDefaultTokens()
        Specified by:
        getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Specified by:
        getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • getRequiredTokens

        public int[] getRequiredTokens()
        Specified by:
        getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • isCommentNodesRequired

        public boolean isCommentNodesRequired()
        Overrides:
        isCommentNodesRequired in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • getViolations

        public SortedSet<com.puppycrawl.tools.checkstyle.api.Violation> getViolations()
        Overrides:
        getViolations in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • beginTree

        public void beginTree​(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)
        Overrides:
        beginTree in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • finishTree

        public void finishTree​(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)
        Overrides:
        finishTree in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • visitToken

        public void visitToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
        Overrides:
        visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • leaveToken

        public void leaveToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
        Overrides:
        leaveToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck