Package com.puppycrawl.tools.checkstyle.api

Interface BeforeExecutionFileFilter

All Known Implementing Classes:
BeforeExecutionExclusionFileFilter, BeforeExecutionFileFilterSet
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 BeforeExecutionFileFilter
An interface for before execution file filtering events.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accept(String uri)
    Determines whether or not a before execution file filtered event is accepted.

  • Method Details

    • accept

      boolean accept(String uri)
      Determines whether or not a before execution file filtered event is accepted. An accepted file is processed by Checkstyle and its violations are kept in the final report; a rejected file is excluded from processing entirely. In other words, returning true lets the file (and any resulting violations) reach the report, while returning false skips the file.
      Parameters:
      uri - the uri to filter.
      Returns:
      true if the file is accepted and should be processed; false to exclude the file so its violations never reach the final report.