Class SuppressFilterElement
java.lang.Object
com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
- All Implemented Interfaces:
Filter
This filter element is immutable and processes
AuditEvent
objects based on the criteria of file, check, module id, line, and
column. It rejects an AuditEvent if the following match:
- the event's file name; and
- the check name or the module identifier; and
- (optionally) the event's line is in the filter's line CSV; and
- (optionally) the check's columns is in the filter's column CSV.
-
Constructor Summary
ConstructorsConstructorDescriptionSuppressFilterElement
(String files, String checks, String message, String modId, String lines, String columns) Constructs aSuppressFilterElement
for a file name pattern.SuppressFilterElement
(Pattern files, Pattern checks, Pattern message, String moduleId, String lines, String columns) Creates aSuppressFilterElement
instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
accept
(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.boolean
int
hashCode()
-
Constructor Details
-
SuppressFilterElement
public SuppressFilterElement(String files, String checks, String message, String modId, String lines, String columns) Constructs aSuppressFilterElement
for a file name pattern.- Parameters:
files
- regular expression for names of filtered files.checks
- regular expression for filtered check classes.message
- regular expression for messages.modId
- the idlines
- lines CSV values and ranges for line number filtering.columns
- columns CSV values and ranges for column number filtering.
-
SuppressFilterElement
public SuppressFilterElement(Pattern files, Pattern checks, Pattern message, String moduleId, String lines, String columns) Creates aSuppressFilterElement
instance.- Parameters:
files
- regular expression for filtered file nameschecks
- regular expression for filtered check classesmessage
- regular expression for messages.moduleId
- the module idlines
- CSV for linescolumns
- CSV for columns
-
-
Method Details
-
accept
Description copied from interface:Filter
Determines whether or not a filtered AuditEvent is accepted. -
hashCode
public int hashCode() -
equals
-