Class SuppressFilterElement
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.filters.SuppressFilterElement
-
- All Implemented Interfaces:
Filter
public class SuppressFilterElement extends Object implements Filter
This filter element is immutable and processesAuditEvent
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.
-
-
Field Summary
Fields Modifier and Type Field Description private Pattern
checkRegexp
The regexp to match check names against.private CsvFilterElement
columnFilter
Column number filter.private String
columnsCsv
CSV for column number filter.private Pattern
fileRegexp
The regexp to match file names against.private CsvFilterElement
lineFilter
Line number filter.private String
linesCsv
CSV for line number filter.private Pattern
messageRegexp
The regexp to match message names against.private String
moduleId
Module id filter.
-
Constructor Summary
Constructors Constructor Description SuppressFilterElement(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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(AuditEvent event)
Determines whether or not a filtered AuditEvent is accepted.boolean
equals(Object other)
private static String
getPatternSafely(Pattern pattern)
Util method to get pattern String value from Pattern object safely, return null if pattern object is null.int
hashCode()
private boolean
isFileNameAndModuleNameMatching(AuditEvent event)
Is matching by file name, module id, and Check name.private boolean
isLineAndColumnMatching(AuditEvent event)
Whether line and column match.private boolean
isMessageNameMatching(AuditEvent event)
Is matching by message.
-
-
-
Field Detail
-
fileRegexp
private final Pattern fileRegexp
The regexp to match file names against.
-
checkRegexp
private final Pattern checkRegexp
The regexp to match check names against.
-
messageRegexp
private final Pattern messageRegexp
The regexp to match message names against.
-
lineFilter
private final CsvFilterElement lineFilter
Line number filter.
-
columnFilter
private final CsvFilterElement columnFilter
Column number filter.
-
columnsCsv
private final String columnsCsv
CSV for column number filter.
-
-
Constructor Detail
-
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 Detail
-
accept
public boolean accept(AuditEvent event)
Description copied from interface:Filter
Determines whether or not a filtered AuditEvent is accepted.
-
isFileNameAndModuleNameMatching
private boolean isFileNameAndModuleNameMatching(AuditEvent event)
Is matching by file name, module id, and Check name.- Parameters:
event
- event- Returns:
- true if it is matching
-
isMessageNameMatching
private boolean isMessageNameMatching(AuditEvent event)
Is matching by message.- Parameters:
event
- event- Returns:
- true if it is matching or not set.
-
isLineAndColumnMatching
private boolean isLineAndColumnMatching(AuditEvent event)
Whether line and column match.- Parameters:
event
- event to process.- Returns:
- true if line and column are matching or not set.
-
getPatternSafely
private static String getPatternSafely(Pattern pattern)
Util method to get pattern String value from Pattern object safely, return null if pattern object is null.- Parameters:
pattern
- pattern object- Returns:
- value of pattern or null
-
-