SuppressElement (Checkstyle API)

Class SuppressElement

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
	SuppressElement(String aFiles) Constructs a `SuppressElement` for a file name pattern.

Constructor Summary

SuppressElement(String aFiles)

Constructs a SuppressElement for a file name pattern.

Method Summary
boolean	accept(AuditEvent aEvent)
boolean	equals(Object aObject)
int	hashCode()
void	setChecks(String aChecks) Set the check class pattern.
void	setColumns(String aColumns) Sets the CSV values and ranges for column number filtering.
void	setLines(String aLines) Sets the CSV values and ranges for line number filtering.
void	setModuleId(String aModuleId) Set the module id for filtering.
String	toString()

Method Summary

boolean

accept(AuditEvent aEvent)

boolean

equals(Object aObject)

int

hashCode()

void

setChecks(String aChecks)

Set the check class pattern.

void

setColumns(String aColumns)