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'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.
Check have following options:
To configure the filter to exclude all 'module-info.java' files:
<module name="BeforeExecutionExclusionFileFilter"> <property name="fileNamePattern" value="module\-info\.java$"/> </module>
AutomaticBean.OutputStreamOptions
Constructor and Description |
---|
BeforeExecutionExclusionFileFilter() |
Modifier and Type | Method and Description |
---|---|
boolean |
accept(String uri)
Determines whether or not a before execution file filtered event is accepted.
|
protected void |
finishLocalSetup()
Provides a hook to finish the part of this component's setup that
was not handled by the bean introspection.
|
void |
setFileNamePattern(Pattern fileNamePattern)
Sets regular expression of the file to exclude.
|
configure, contextualize, getConfiguration, setupChild
public BeforeExecutionExclusionFileFilter()
public void setFileNamePattern(Pattern fileNamePattern)
fileNamePattern
- regular expression of the excluded file.protected void finishLocalSetup()
AutomaticBean
The default implementation does nothing.
finishLocalSetup
in class AutomaticBean
public boolean accept(String uri)
BeforeExecutionFileFilter
accept
in interface BeforeExecutionFileFilter
uri
- the uri to filter.Copyright © 2001–2018. All rights reserved.