Package com.puppycrawl.tools.checkstyle.filters

Class SuppressionXpathSingleFilter

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.filters.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 to use suppressions configured in the same config as other modules. SuppressionFilter and SuppressionXpathFilter require a 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 Details

    • xpathFilter

      private XpathFilterElement xpathFilter
      XpathFilterElement instance.

    • files

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

    • checks

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

    • message

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

    • id

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

    • query

      private String query
      Define a string xpath query.

  • Constructor Details

  • Method Details

    • setFiles

      public void setFiles(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(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(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(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(String query)
      Setter to define a string xpath query.
      Parameters:
      query - the xpath query
      Since:
      8.18

    • finishLocalSetup

      protected void finishLocalSetup()
      Description copied from class: AbstractAutomaticBean
      Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

      The default implementation does nothing.

      Specified by:
      finishLocalSetup in class AbstractAutomaticBean

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