Class BeforeExecutionExclusionFileFilter
- All Implemented Interfaces:
BeforeExecutionFileFilter
,Configurable
,Contextualizable
File filter BeforeExecutionExclusionFileFilter
decides which files should be
excluded from being processed by the utility.
By default Checkstyle includes all files and sub-directories in a directory to be processed and
checked for violations. Users could have files that are in these sub-directories 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 Exception
and halt parsing any more files for violations.
An example of a valid Java file Checkstyle can't parse is JDK 9's module-info.java
.
This file filter will exclude these problem files from being parsed, allowing the rest of the
files to run normal and be validated.
Note: When a file is excluded from the utility, it is excluded from all Checks and no testing for violations will be performed on them.
-
Property
fileNamePattern
- Define regular expression to match the file name against. Type isjava.util.regex.Pattern
. Default value isnull
.
To configure the filter to exclude all 'module-info.java' files:
<module name="BeforeExecutionExclusionFileFilter"> <property name="fileNamePattern" value="module\-info\.java$"/> </module>
Parent is com.puppycrawl.tools.checkstyle.Checker
- Since:
- 7.2
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines whether or not a before execution file filtered event is accepted.protected void
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.void
setFileNamePattern
(Pattern fileNamePattern) Setter to define regular expression to match the file name against.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Constructor Details
-
BeforeExecutionExclusionFileFilter
public BeforeExecutionExclusionFileFilter()
-
-
Method Details
-
setFileNamePattern
Setter to define regular expression to match the file name against.- Parameters:
fileNamePattern
- regular expression of the excluded file.
-
finishLocalSetup
protected void finishLocalSetup()Description copied from class:AutomaticBean
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.The default implementation does nothing.
- Specified by:
finishLocalSetup
in classAutomaticBean
-
accept
Description copied from interface:BeforeExecutionFileFilter
Determines whether or not a before execution file filtered event is accepted.- Specified by:
accept
in interfaceBeforeExecutionFileFilter
- Parameters:
uri
- the uri to filter.- Returns:
- true if the event is accepted.
-