Package com.puppycrawl.tools.checkstyle.filters

Class SuppressionXpathFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.filters.SuppressionXpathFilter

All Implemented Interfaces:

Configurable, Contextualizable, ExternalResourceHolder, TreeWalkerFilter

public class SuppressionXpathFilter
extends AutomaticBean
implements TreeWalkerFilter, ExternalResourceHolder

This filter accepts TreeWalkerAuditEvents according to file, check and xpath query, as specified in a suppression file.

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor	Description
SuppressionXpathFilter()

Method Summary

Modifier and Type	Method	Description
boolean	accept(TreeWalkerAuditEvent treeWalkerAuditEvent)	Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
boolean	equals(java.lang.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.
java.util.Set<java.lang.String>	getExternalResourceLocations()	Returns a set of external configuration resource locations which are used by the module.
int	hashCode()
void	setFile(java.lang.String fileName)	Sets name of the suppression 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

SuppressionXpathFilter

public SuppressionXpathFilter()

Method Detail

setFile

public void setFile(java.lang.String fileName)

Sets name of the suppression 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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

accept

public boolean accept(TreeWalkerAuditEvent treeWalkerAuditEvent)

Description copied from interface: TreeWalkerFilter

Determines whether or not a filtered TreeWalkerAuditEvent is accepted.

Specified by:

accept in interface TreeWalkerFilter

Parameters:

treeWalkerAuditEvent - the TreeWalkerAuditEvent to filter.

Returns:

true if the event is accepted.

getExternalResourceLocations

public java.util.Set<java.lang.String> getExternalResourceLocations()

Description copied from interface: ExternalResourceHolder

Returns a set of external configuration resource locations which are used by the module. ATTENTION! If 'getExternalResourceLocations()' return null, there will be NullPointerException in Checker. Such behaviour will signal that your module (check or filter) is designed incorrectly. It make sense to return an empty set from 'getExternalResourceLocations()' only for composite modules like TreeWalker.

Specified by:

getExternalResourceLocations in interface ExternalResourceHolder

Returns:

a set of external configuration resource locations which are used by the module.

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.

Specified by:

finishLocalSetup in class AutomaticBean

Throws:

CheckstyleException - if there is a configuration error.