com.puppycrawl.tools.checkstyle.filters

Class SuppressElement

java.lang.Object

com.puppycrawl.tools.checkstyle.filters.SuppressElement

All Implemented Interfaces:

Filter

public class SuppressElement
extends Object
implements Filter

This filter 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.

Author:

Rick Giles

Constructor Summary

Constructors

Constructor and Description
SuppressElement(String files) Constructs a SuppressElement for a file name pattern.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.
boolean	equals(Object object)
int	hashCode()
void	setChecks(String checks) Set the check class pattern.
void	setColumns(String columns) Sets the CSV values and ranges for column number filtering.
void	setLines(String lines) Sets the CSV values and ranges for line number filtering.
void	setModuleId(String moduleId) Set the module id for filtering.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressElement

public SuppressElement(String files)
                throws PatternSyntaxException

Constructs a SuppressElement for a file name pattern. Must either call setColumns(String) or setModuleId(String) before using this object.

Parameters:

files - regular expression for names of filtered files.

Throws:

PatternSyntaxException - if there is an error.

Method Detail

setChecks

public void setChecks(String checks)

Set the check class pattern.

Parameters:

checks - regular expression for filtered check classes.

setModuleId

public void setModuleId(String moduleId)

Set the module id for filtering. Cannot be null.

Parameters:

moduleId - the id

setLines

public void setLines(String lines)

Sets the CSV values and ranges for line number filtering. E.g. "1,7-15,18".

Parameters:

lines - CSV values and ranges for line number filtering.

setColumns

public void setColumns(String columns)

Sets the CSV values and ranges for column number filtering. E.g. "1,7-15,18".

Parameters:

columns - CSV values and ranges for column number filtering.

accept

public boolean accept(AuditEvent event)

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.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object