com.puppycrawl.tools.checkstyle.filters

Class SuppressElement

Implemented Interfaces:
Filter

public class SuppressElement
extends java.lang.Object
implements Filter

This filter accepts AuditEvents according to file, check, line, and column conditions. It rejects an AuditEvent if the event's file name and check name match the filter's file name and check name patterns, and the event's line is in the filter's line CSV or the check's columns is in the filter's column CSV.

Author:
Rick Giles

Constructor Summary

SuppressElement(String aFiles, String aChecks)
Constructs a SuppressElement for a file name pattern and and a check class pattern.

Method Summary

boolean
accept(AuditEvent aEvent)
boolean
equals(Object aObject)
int
hashCode()
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.
String
toString()

Constructor Details

SuppressElement

public SuppressElement(String aFiles,
                       String aChecks)
            throws RESyntaxException
Constructs a SuppressElement for a file name pattern and and a check class pattern.

Parameters:
aFiles - regular expression for names of filtered files.
aChecks - regular expression for filtered check classes.

Method Details

accept

public boolean accept(AuditEvent aEvent)
Specified by:
accept in interface Filter

See Also:
Filter


equals

public boolean equals(Object aObject)

See Also:
java.lang.Object.equals(java.lang.Object)


hashCode

public int hashCode()

See Also:
java.lang.Object.hashCode()


setColumns

public void setColumns(String aColumns)
Sets the CSV values and ranges for column number filtering. E.g. "1,7-15,18".

Parameters:
aColumns - CSV values and ranges for column number filtering.


setLines

public void setLines(String aLines)
Sets the CSV values and ranges for line number filtering. E.g. "1,7-15,18".

Parameters:
aLines - CSV values and ranges for line number filtering.


toString

public String toString()

See Also:
java.lang.Object.toString()