1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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.filefilters;
21
22 import java.util.regex.Pattern;
23
24 import com.puppycrawl.tools.checkstyle.AbstractAutomaticBean;
25 import com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilter;
26
27 /**
28 * <div>
29 * File filter {@code BeforeExecutionExclusionFileFilter} decides which files should be
30 * excluded from being processed by the utility.
31 * </div>
32 *
33 * <p>
34 * By default, Checkstyle includes all files and subdirectories in a directory to be processed and
35 * checked for violations. Users could have files that are in these subdirectories that shouldn't
36 * be processed with their checkstyle configuration for various reasons, one of which is a valid
37 * Java file that won't pass Checkstyle's parser. When Checkstyle tries to parse a Java file and
38 * fails, it will throw an {@code Exception} and halt parsing any more files for violations.
39 * An example of a valid Java file Checkstyle can't parse is JDK 9's {@code module-info.java}.
40 * This file filter will exclude these problem files from being parsed, allowing the rest of the
41 * files to run normal and be validated.
42 * </p>
43 *
44 * <p>
45 * <b>Note:</b> When a file is excluded from the utility, it is excluded from all Checks and no
46 * testing for violations will be performed on them.
47 * </p>
48 * <ul>
49 * <li>
50 * Property {@code fileNamePattern} - Define regular expression to match the file name against.
51 * Type is {@code java.util.regex.Pattern}.
52 * Default value is {@code null}.</li>
53 * </ul>
54 *
55 * <p>
56 * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
57 * </p>
58 *
59 * @since 7.2
60 */
61 public final class BeforeExecutionExclusionFileFilter extends AbstractAutomaticBean
62 implements BeforeExecutionFileFilter {
63
64 /** Define regular expression to match the file name against. */
65 private Pattern fileNamePattern;
66
67 /**
68 * Setter to define regular expression to match the file name against.
69 *
70 * @param fileNamePattern regular expression of the excluded file.
71 * @since 7.2
72 */
73 public void setFileNamePattern(Pattern fileNamePattern) {
74 this.fileNamePattern = fileNamePattern;
75 }
76
77 @Override
78 protected void finishLocalSetup() {
79 // No code by default
80 }
81
82 @Override
83 public boolean accept(String uri) {
84 return fileNamePattern == null || !fileNamePattern.matcher(uri).find();
85 }
86
87 }