-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathbeforeexecutionexclusionfilefilter.html
390 lines (331 loc) · 16.7 KB
/
beforeexecutionexclusionfilefilter.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/filefilters/beforeexecutionexclusionfilefilter.xml at 2025-04-02
| Rendered using Apache Maven Fluido Skin 2.0.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
<title>BeforeExecutionExclusionFileFilter – checkstyle</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-2.0.1.min.css" />
<link rel="stylesheet" href="../css/site.css" />
<link rel="stylesheet" href="../css/print.css" media="print" />
<script src="../js/apache-maven-fluido-2.0.1.min.js"></script>
<script type="text/javascript" src="../js/checkstyle.js"></script>
<script type="text/javascript" src="../js/anchors.js"></script>
<script type="text/javascript" src="../js/google-analytics.js"></script>
<script type="text/javascript" src="../js/copy-clipboard.js"></script>
<link rel="icon" href="../images/favicon.png" type="image/x-icon" />
<link rel="shortcut icon" href="../images/favicon.ico" type="image/ico" />
</head>
<body>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h1><a href=".././"><img class="class java.lang.Object" src="../images/header-checkstyle-logo.png" alt="Checkstyle" /></a></h1></div></div>
<div class="pull-right"><div id="bannerRight"><h1><img class="class java.lang.Object" src="../images/header-right-ruller.png" alt="Checkstyle" /></h1></div></div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2025-04-02</li>
<li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 10.23.0</li>
<li class="pull-right"><a>toTop</a></li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">About</li>
<li><a href="../index.html">Checkstyle</a></li>
<li><a href="../releasenotes.html">Release Notes</a></li>
<li><a href="../consulting.html">Consulting</a></li>
<li><a href="../sponsoring.html">Sponsoring</a></li>
<li class="nav-header">Documentation</li>
<li><a href="../config.html"><span class="icon-chevron-down"></span>Configuration</a>
<ul class="nav nav-list">
<li><a href="../property_types.html">Property Types</a></li>
<li><a href="../config_system_properties.html">System Properties</a></li>
</ul></li>
<li><a href="../running.html"><span class="icon-chevron-down"></span>Running</a>
<ul class="nav nav-list">
<li><a href="../anttask.html">Ant Task</a></li>
<li><a href="../cmdline.html">Command Line</a></li>
</ul></li>
<li><a href="../checks.html"><span class="icon-chevron-down"></span>Checks</a>
<ul class="nav nav-list">
<li><a href="../checks/annotation/index.html"><span class="icon-chevron-right"></span>Annotations</a></li>
<li><a href="../checks/blocks/index.html"><span class="icon-chevron-right"></span>Block Checks</a></li>
<li><a href="../checks/design/index.html"><span class="icon-chevron-right"></span>Class Design</a></li>
<li><a href="../checks/coding/index.html"><span class="icon-chevron-right"></span>Coding</a></li>
<li><a href="../checks/header/index.html"><span class="icon-chevron-right"></span>Headers</a></li>
<li><a href="../checks/imports/index.html"><span class="icon-chevron-right"></span>Imports</a></li>
<li><a href="../checks/javadoc/index.html"><span class="icon-chevron-right"></span>Javadoc Comments</a></li>
<li><a href="../checks/metrics/index.html"><span class="icon-chevron-right"></span>Metrics</a></li>
<li><a href="../checks/misc/index.html"><span class="icon-chevron-right"></span>Miscellaneous</a></li>
<li><a href="../checks/modifier/index.html"><span class="icon-chevron-right"></span>Modifiers</a></li>
<li><a href="../checks/naming/index.html"><span class="icon-chevron-right"></span>Naming Conventions</a></li>
<li><a href="../checks/regexp/index.html"><span class="icon-chevron-right"></span>Regexp</a></li>
<li><a href="../checks/sizes/index.html"><span class="icon-chevron-right"></span>Size Violations</a></li>
<li><a href="../checks/whitespace/index.html"><span class="icon-chevron-right"></span>Whitespace</a></li>
</ul></li>
<li><a href="../filters/index.html"><span class="icon-chevron-right"></span>Filters</a></li>
<li><a href="../filefilters/index.html"><span class="icon-chevron-down"></span>File Filters</a>
<ul class="nav nav-list">
<li class="active"><a>BeforeExecutionExclusionFileFilter</a></li>
</ul></li>
<li><a href="../style_configs.html"><span class="icon-chevron-down"></span>Style Configurations</a>
<ul class="nav nav-list">
<li><a href="../google_style.html">Google's Style</a></li>
<li><a href="../sun_style.html">Sun's Style</a></li>
</ul></li>
<li class="nav-header">Developers</li>
<li><a href="../extending.html"><span class="icon-chevron-down"></span>Extending Checkstyle</a>
<ul class="nav nav-list">
<li><a href="../writingchecks.html">Writing Checks</a></li>
<li><a href="../writingjavadocchecks.html">Writing Javadoc Checks</a></li>
<li><a href="../writingfilters.html">Writing Filters</a></li>
<li><a href="../writingfilefilters.html">Writing File Filters</a></li>
<li><a href="../writinglisteners.html">Writing Listeners</a></li>
</ul></li>
<li><a href="../contributing.html">Contributing</a></li>
<li><a href="../beginning_development.html"><span class="icon-chevron-down"></span>Beginning Development</a>
<ul class="nav nav-list">
<li><a href="../eclipse.html">Eclipse IDE</a></li>
<li><a href="../netbeans.html">NetBeans IDE</a></li>
<li><a href="../idea.html">IntelliJ IDE</a></li>
</ul></li>
<li><a href="../apidocs/index.html">Javadoc</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="../project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<a href="https://github.com/checkstyle/checkstyle" class="builtBy"><img class="builtBy" src="../images/github_logo_social_coding_outlined.png" alt="GitHub" /></a>
<a href="https://twitter.com/checkstyle_java/" class="builtBy"><img class="builtBy" src="../images/twitter_button.png" alt="Twitter" /></a>
<a href="https://stackoverflow.com/questions/tagged/checkstyle" class="builtBy"><img class="builtBy" src="../images/stackoverflow.jpeg" alt="Stackoverflow" /></a>
<a href="https://groups.google.com/forum/#!forum/checkstyle" class="builtBy"><img class="builtBy" src="../images/groups.png" alt="GoogleGroups" /></a>
<a href="https://www.ej-technologies.com/products/jprofiler/overview.html" class="builtBy"><img class="builtBy" src="https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" alt="JProfiler" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10">
<section><a id="BeforeExecutionExclusionFileFilter"></a>
<h1>BeforeExecutionExclusionFileFilter</h1>
<p>Since Checkstyle 7.2</p>
<a id="Description"></a><section id="Description"><a id="Description"></a>
<h2>Description</h2>
<div>
File filter <code>BeforeExecutionExclusionFileFilter</code> decides which files should be
excluded from being processed by the utility.
</div>
<p>
By default, Checkstyle includes all files and subdirectories in a directory to be
processed and checked for violations. Users could have files that are in these
subdirectories that shouldn't be processed with their checkstyle configuration for
various reasons, one of which is a valid Java file that won't pass Checkstyle's parser.
When Checkstyle tries to parse a Java file and fails, it will throw an
<code>Exception</code> and halt parsing any more files for violations. An example of a
valid Java file Checkstyle can't parse is JDK 9's <code>module-info.java</code>.
This file filter will exclude these problem files from being parsed,
allowing the rest of the files to run normal and be validated.
</p>
<p>
<b>Note:</b> When a file is excluded from the utility, it is excluded from all Checks and
no testing for violations will be performed on them.
</p>
</section>
<a id="Properties"></a><section id="Properties"><a id="Properties"></a>
<h2>Properties</h2>
<div class="wrapper">
<table class="table table-striped">
<tr class="a">
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr class="b">
<td>fileNamePattern</td>
<td>Define regular expression to match the file name against.</td>
<td><a href="../property_types.html#Pattern">Pattern</a></td>
<td><code>null</code></td>
<td>7.2</td>
</tr>
</table>
</div>
</section>
<a id="Examples"></a><section id="Examples"><a id="Examples"></a>
<h2>Examples</h2>
<p id="Example1-config">
With the default configuration, no files are matched against the
<code>fileNamePattern</code>, so the filter does not affect the audit:
</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-xml">
<module name="Checker">
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="^[A-Z].*"/>
<property name="match" value="false"/>
<message key="regexp.filename.mismatch"
value="File name must start with an uppercase."/>
</module>
<module name="BeforeExecutionExclusionFileFilter"/>
</module>
</code></pre></div>
<p id="Example1-code">Example:</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-java">
.../Example1.java
.../Example2.java
.../Example3.java
.../Example4.java
.../test/generated_TestCase1.java // violation, name must start with an uppercase
.../test/generated_StubBankRemote.java // violation, must start with an uppercase
.../test/MockPaymentRemote.java
.../module-info.java // violation, name must start with an uppercase
</code></pre></div>
<p id="Example2-config">
To configure the filter to exclude all 'module-info.java' files:
</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-xml">
<module name="Checker">
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="^[A-Z].*"/>
<property name="match" value="false"/>
<message key="regexp.filename.mismatch"
value="File name must start with an uppercase."/>
</module>
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
</module>
</code></pre></div>
<p id="Example2-code">Example:</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-java">
.../Example1.java
.../Example2.java
.../Example3.java
.../Example4.java
.../test/generated_TestCase1.java // violation, name must start with an uppercase
.../test/generated_StubBankRemote.java // violation, must start with an uppercase
.../test/MockPaymentRemote.java
.../module-info.java // OK, the file is not audited
</code></pre></div>
<p id="Example3-config">
To configure the filter to run only on required files for example that ends with "Remote"
or end with "Client" in names or named as "Remote.java" or "Client.java"
use <a href="https://www.regular-expressions.info/lookaround.html" class="externalLink">negative lookahead</a>:
</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-xml">
<module name="Checker">
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="^[A-Z].*"/>
<property name="match" value="false"/>
<message key="regexp.filename.mismatch"
value="File name must start with an uppercase."/>
</module>
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern"
value="^(?!.*([\\/])?(Remote|Client)\.java$).*"/>
</module>
</module>
</code></pre></div>
<p id="Example3-code">Example:</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-java">
.../Example1.java
.../Example2.java
.../Example3.java
.../Example4.java
.../test/generated_TestCase1.java // OK, the file is not audited
.../test/generated_StubBankRemote.java // violation, must start with an uppercase
.../test/MockPaymentRemote.java
.../module-info.java // OK, the file is not audited
</code></pre></div>
<p id="Example4-config">
To configure the filter to exclude all 'test' folder files and all 'module-info.java'
files:
</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-xml">
<module name="Checker">
<module name="RegexpOnFilename">
<property name="fileNamePattern" value="^[A-Z].*"/>
<property name="match" value="false"/>
<message key="regexp.filename.mismatch"
value="File name must start with an uppercase."/>
</module>
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern"
value="(.*[\\/]test[\\/].*$)|(module\-info\.java$)"/>
</module>
</module>
</code></pre></div>
<p id="Example4-code">Example:</p>
<div class="wrapper">
<pre class="prettyprint"><code class="language-java">
.../Example1.java
.../Example2.java
.../Example3.java
.../Example4.java
.../test/generated_TestCase1.java // OK, 'test' folder is not audited
.../test/generated_StubBankRemote.java // OK, 'test' folder is not audited
.../test/MockPaymentRemote.java
.../module-info.java // OK, the file is not audited
</code></pre></div>
</section>
<a id="Example_of_Usage"></a><section id="Example_of_Usage"><a id="Example_of_Usage"></a>
<h2>Example of Usage</h2>
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%20path%3A**%2Fgoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter" class="externalLink">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%20path%3A**%2Fsun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter" class="externalLink">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig%20path%3A**%2Fcheckstyle-checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter" class="externalLink">
Checkstyle Style</a>
</li>
</ul>
</section>
<a id="Package"></a><section id="Package"><a id="Package"></a>
<h2>Package</h2>
<p> com.puppycrawl.tools.checkstyle.filefilters </p>
</section>
<a id="Parent_Module"></a><section id="Parent_Module"><a id="Parent_Module"></a>
<h2>Parent Module</h2>
<p>
<a href="../config.html#Checker">Checker</a>
</p>
</section>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2001–2025
</p>
</div>
</div>
</footer>
</body>
</html>