Package com.puppycrawl.tools.checkstyle

Interface TreeWalkerFilter

All Known Implementing Classes:

SuppressionCommentFilter, SuppressionXpathFilter, SuppressionXpathSingleFilter, SuppressWithNearbyCommentFilter, XpathFileGeneratorAstFilter, XpathFilterElement

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface TreeWalkerFilter

An interface for filtering TreeWalkerAuditEvent.

Method Summary

Modifier and Type	Method	Description
boolean	accept(TreeWalkerAuditEvent treeWalkerAuditEvent)	Determines whether or not a filtered TreeWalkerAuditEvent is accepted.

Method Details

accept

boolean accept(TreeWalkerAuditEvent treeWalkerAuditEvent)

Determines whether or not a filtered TreeWalkerAuditEvent is accepted. An accepted event is kept in the final report as a violation; a rejected event is filtered out. In other words, returning true makes the violation appear in the report, while returning false suppresses it.

Parameters:

treeWalkerAuditEvent - the TreeWalkerAuditEvent to filter.

Returns:

true if the event is accepted and its violation should appear in the final report; false to suppress the event.