com.puppycrawl.tools.checkstyle.filters

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

Constructors

Constructor and Description
SuppressFilterElement(Pattern files, Pattern checks, Pattern message, String moduleId, String lines, String columns) Creates a SuppressFilterElement instance.
SuppressFilterElement(String files, String checks, String message, String modId, String lines, String columns) Constructs a SuppressFilterElement for a file name pattern.

Method Summary

Modifier and Type	Method and Description
boolean	accept(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.
boolean	equals(Object other)
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressFilterElement

public SuppressFilterElement(String files,
                             String checks,
                             String message,
                             String modId,
                             String lines,
                             String columns)

Constructs a SuppressFilterElement 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 id

lines - 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 a SuppressFilterElement instance.

Parameters:

files - regular expression for filtered file names

checks - regular expression for filtered check classes

message - regular expression for messages.

moduleId - the module id

lines - CSV for lines

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

Specified by:

accept in interface Filter

Parameters:

event - the AuditEvent 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