Package com.puppycrawl.tools.checkstyle.api

Interface Filter

All Known Implementing Classes:
FilterSet, SeverityMatchFilter, SuppressFilterElement, SuppressionFilter, SuppressionSingleFilter, SuppressWarningsFilter, SuppressWithNearbyTextFilter, SuppressWithPlainTextCommentFilter
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 Filter
An interface for filtering AuditEvents.

  • Method Summary

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

  • Method Details

    • accept

      boolean accept(AuditEvent event)
      Determines whether or not a filtered AuditEvent 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:
      event - the AuditEvent to filter.
      Returns:
      true if the event is accepted and its violation should appear in the final report; false to suppress the event.