1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.api;
21
22 /**
23 * An interface for before execution file filtering events.
24 */
25 @FunctionalInterface
26 public interface BeforeExecutionFileFilter {
27
28 /**
29 * Determines whether or not a before execution file filtered event is accepted.
30 * An accepted file is processed by Checkstyle and its violations are kept in
31 * the final report; a rejected file is excluded from processing entirely.
32 * In other words, returning {@code true} lets the file (and any resulting
33 * violations) reach the report, while returning {@code false} skips the file.
34 *
35 * @param uri the uri to filter.
36 * @return true if the file is accepted and should be processed; false to
37 * exclude the file so its violations never reach the final report.
38 */
39 boolean accept(String uri);
40
41 }