com.puppycrawl.tools.checkstyle.filters

Class SuppressionFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.filters.SuppressionFilter

All Implemented Interfaces:

Configurable, Contextualizable, Filter

public class SuppressionFilter
extends AutomaticBean
implements Filter

This filter accepts AuditEvents according to file, check, line, and column, as specified in a suppression file.

Author:

Rick Giles, liscju

Constructor Summary

Constructors

Constructor and Description
SuppressionFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(AuditEvent event) Determines whether or not a filtered AuditEvent is accepted.
boolean	equals(Object obj)
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
int	hashCode()
void	setFile(String fileName) Sets name of the supression file.
void	setOptional(boolean optional) Sets whether config file existence is optional.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressionFilter

public SuppressionFilter()

Method Detail

setFile

public void setFile(String fileName)

Sets name of the supression file.

Parameters:

fileName - name of the suppressions file.

setOptional

public void setOptional(boolean optional)

Sets whether config file existence is optional.

Parameters:

optional - tells if config file existence is optional.

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

finishLocalSetup

protected void finishLocalSetup()
                         throws CheckstyleException

Description copied from class: AutomaticBean

Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

The default implementation does nothing.

Overrides:

finishLocalSetup in class AutomaticBean

Throws:

CheckstyleException - if there is a configuration error.