Class BeforeExecutionExclusionFileFilter
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.filefilters.BeforeExecutionExclusionFileFilter
-
- All Implemented Interfaces:
BeforeExecutionFileFilter
,Configurable
,Contextualizable
public final class BeforeExecutionExclusionFileFilter extends AutomaticBean implements BeforeExecutionFileFilter
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'smodule-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.
Check have following options:
- fileNamePattern - Regular expression to match the file name against. Default value is null.
To configure the filter to exclude all 'module-info.java' files:
<module name="BeforeExecutionExclusionFileFilter"> <property name="fileNamePattern" value="module\-info\.java$"/> </module>
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.regex.Pattern
fileNamePattern
Filename of exclusion.
-
Constructor Summary
Constructors Constructor Description BeforeExecutionExclusionFileFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(java.lang.String uri)
Determines whether or not a before execution file filtered event is accepted.void
setFileNamePattern(java.util.regex.Pattern fileNamePattern)
Sets regular expression of the file to exclude.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Method Detail
-
setFileNamePattern
public void setFileNamePattern(java.util.regex.Pattern fileNamePattern)
Sets regular expression of the file to exclude.- Parameters:
fileNamePattern
- regular expression of the excluded file.
-
accept
public boolean accept(java.lang.String uri)
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.
-
-