com.puppycrawl.tools.checkstyle.filters

Class SuppressionXpathSingleFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.filters.SuppressionXpathSingleFilter

All Implemented Interfaces:

Configurable, Contextualizable, TreeWalkerFilter

public class SuppressionXpathSingleFilter
extends AutomaticBean
implements TreeWalkerFilter

Filter SuppressionXpathSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, and xpath. Attention: This filter only supports single suppression, and will need multiple instances if users wants to suppress multiple violations.

Nested Class Summary

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

AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
SuppressionXpathSingleFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(TreeWalkerAuditEvent treeWalkerAuditEvent) Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
void	setChecks(java.lang.String checks) Set the regular expression to specify the name of the check to suppress.
void	setFiles(java.lang.String files) Set the regular expression to specify names of files to suppress.
void	setId(java.lang.String id) Set the ID of the check to suppress.
void	setMessage(java.lang.String message) Set the regular expression to specify the message of the check to suppress.
void	setQuery(java.lang.String query) Set the xpath query.

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressionXpathSingleFilter

public SuppressionXpathSingleFilter()

Method Detail

setFiles

public void setFiles(java.lang.String files)

Set the regular expression to specify names of files to suppress.

Parameters:

files - the name of the file

setChecks

public void setChecks(java.lang.String checks)

Set the regular expression to specify the name of the check to suppress.

Parameters:

checks - the name of the check

setMessage

public void setMessage(java.lang.String message)

Set the regular expression to specify the message of the check to suppress.

Parameters:

message - the message of the check

setId

public void setId(java.lang.String id)

Set the ID of the check to suppress.

Parameters:

id - the ID of the check

setQuery

public void setQuery(java.lang.String query)

Set the xpath query.

Parameters:

query - the xpath query

finishLocalSetup

protected void finishLocalSetup()

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

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.