Package com.puppycrawl.tools.checkstyle.filters

Class SuppressionXpathSingleFilter

  • All Implemented Interfaces:
    Configurable, Contextualizable, TreeWalkerFilter
    public class SuppressionXpathSingleFilter
extends AbstractAutomaticBean
implements TreeWalkerFilter

    Filter SuppressionXpathSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath.

    Rationale: To allow users use suppressions configured in the same config with other modules. SuppressionFilter and SuppressionXpathFilter are require separate file.

    Advice: If checkstyle configuration is used for several projects, single suppressions on common files/folders is better to put in checkstyle configuration as common rule. All suppression that are for specific file names is better to keep in project specific config file.

    Attention: This filter only supports single suppression, and will need multiple instances if users wants to suppress multiple violations.

    SuppressionXpathSingleFilter can suppress Checks that have Treewalker as parent module.

    • Property checks - Define a Regular Expression matched against the name of the check associated with an audit event. Type is java.util.regex.Pattern. Default value is null.
    • Property files - Define a Regular Expression matched against the file name associated with an audit event. Type is java.util.regex.Pattern. Default value is null.
    • Property id - Define a string matched against the ID of the check associated with an audit event. Type is java.lang.String. Default value is null.
    • Property message - Define a Regular Expression matched against the message of the check associated with an audit event. Type is java.util.regex.Pattern. Default value is null.
    • Property query - Define a string xpath query. Type is java.lang.String. Default value is null.

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Since:
    8.18

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.regex.Pattern checks
      Define a Regular Expression matched against the name of the check associated with an audit event.
      private java.util.regex.Pattern files
      Define a Regular Expression matched against the file name associated with an audit event.
      private java.lang.String id
      Define a string matched against the ID of the check associated with an audit event.
      private java.util.regex.Pattern message
      Define a Regular Expression matched against the message of the check associated with an audit event.
      private java.lang.String query
      Define a string xpath query.
      private XpathFilterElement xpathFilter
      XpathFilterElement instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accept​(TreeWalkerAuditEvent treeWalkerAuditEvent)
      Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
      protected void finishLocalSetup()
      Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
      void setChecks​(java.lang.String checks)
      Setter to define a Regular Expression matched against the name of the check associated with an audit event.
      void setFiles​(java.lang.String files)
      Setter to define a Regular Expression matched against the file name associated with an audit event.
      void setId​(java.lang.String id)
      Setter to define a string matched against the ID of the check associated with an audit event.
      void setMessage​(java.lang.String message)
      Setter to define a Regular Expression matched against the message of the check associated with an audit event.
      void setQuery​(java.lang.String query)
      Setter to define a string xpath query.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • files

        private java.util.regex.Pattern files
        Define a Regular Expression matched against the file name associated with an audit event.

      • checks

        private java.util.regex.Pattern checks
        Define a Regular Expression matched against the name of the check associated with an audit event.

      • message

        private java.util.regex.Pattern message
        Define a Regular Expression matched against the message of the check associated with an audit event.

      • id

        private java.lang.String id
        Define a string matched against the ID of the check associated with an audit event.

      • query

        private java.lang.String query
        Define a string xpath query.

    • Method Detail

      • setFiles

        public void setFiles​(java.lang.String files)
        Setter to define a Regular Expression matched against the file name associated with an audit event.
        Parameters:
        files - the name of the file
        Since:
        8.18

      • setChecks

        public void setChecks​(java.lang.String checks)
        Setter to define a Regular Expression matched against the name of the check associated with an audit event.
        Parameters:
        checks - the name of the check
        Since:
        8.18

      • setMessage

        public void setMessage​(java.lang.String message)
        Setter to define a Regular Expression matched against the message of the check associated with an audit event.
        Parameters:
        message - the message of the check
        Since:
        8.18

      • setId

        public void setId​(java.lang.String id)
        Setter to define a string matched against the ID of the check associated with an audit event.
        Parameters:
        id - the ID of the check
        Since:
        8.18

      • setQuery

        public void setQuery​(java.lang.String query)
        Setter to define a string xpath query.
        Parameters:
        query - the xpath query
        Since:
        8.18

      • accept

        public boolean accept​(TreeWalkerAuditEvent treeWalkerAuditEvent)
        Description copied from interface: TreeWalkerFilter
        Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
        Specified by:
        accept in interface TreeWalkerFilter
        Parameters:
        treeWalkerAuditEvent - the TreeWalkerAuditEvent to filter.
        Returns:
        true if the event is accepted.