Package com.puppycrawl.tools.checkstyle.filters

Class XpathFilterElement

java.lang.Object
com.puppycrawl.tools.checkstyle.filters.XpathFilterElement
All Implemented Interfaces:
TreeWalkerFilter
public class XpathFilterElement extends Object implements TreeWalkerFilter
This filter element is immutable and processes TreeWalkerAuditEvent objects based on the criteria of file, check, module id, xpathQuery.

  • Constructor Details

    • XpathFilterElement

      public XpathFilterElement(String files, String checks, String message, String moduleId, String query)
      Creates a XpathElement instance.
      Parameters:
      files - regular expression for names of filtered files
      checks - regular expression for filtered check classes
      message - regular expression for messages.
      moduleId - the module id
      query - the xpath query

    • XpathFilterElement

      public XpathFilterElement(Pattern files, Pattern checks, Pattern message, String moduleId, String query)
      Creates a XpathElement instance.
      Parameters:
      files - regular expression for names of filtered files
      checks - regular expression for filtered check classes
      message - regular expression for messages.
      moduleId - the module id
      query - the xpath query

  • Method Details

    • accept

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object