com.puppycrawl.tools.checkstyle.checks.regexp

Class RegexpOnFilenameCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck

public class RegexpOnFilenameCheck
extends AbstractFileSetCheck

Checks that a specified pattern matches based on file and/or folder path. It can also be used to verify files match specific naming patterns not covered by other checks (Ex: properties, xml, etc.).

When customizing the check, the properties are applied in a specific order. The fileExtensions property first picks only files that match any of the specific extensions supplied. Once files are matched against the fileExtensions, the match property is then used in conjunction with the patterns to determine if the check is looking for a match or mis-match on those files. If the fileNamePattern is supplied, the matching is only applied to the fileNamePattern and not the folderPattern. If no fileNamePattern is supplied, then matching is applied to the folderPattern only and will result in all files in a folder to be reported on violations. If no folderPattern is supplied, then all folders that checkstyle finds are examined for violations. The ignoreFileNameExtensions property drops the file extension and applies the fileNamePattern only to the rest of file name. For example, if the file is named 'test.java' and this property is turned on, the pattern is only applied to 'test'.

If this check is configured with no properties, then the default behavior of this check is to report file names with spaces in them. When at least one pattern property is supplied, the entire check is under the user's control to allow them to fully customize the behavior.

It is recommended that if you create your own pattern, to also specify a custom violation message. This allows the violation message printed to be clear what the violation is, especially if multiple RegexpOnFilename checks are used. Argument 0 for the message populates the check's folderPattern. Argument 1 for the message populates the check's fileNamePattern. The file name is not passed as an argument since it is part of CheckStyle's default violation messages.

• Property folderPattern - Specify the regular expression to match the folder path against. Type is java.util.regex.Pattern. Default value is null.
• Property fileNamePattern - Specify the regular expression to match the file name against. Type is java.util.regex.Pattern. Default value is null.
• Property match - Control whether to look for a match or mis-match on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern. Type is boolean. Default value is true.
• Property ignoreFileNameExtensions - Control whether to ignore the file extension for the file name match. Type is boolean. Default value is false.
• Property fileExtensions - Specify the file type extension of files to process. If this is specified, then only files that match these types are examined with the other patterns. Type is java.lang.String[]. Default value is all files.

To configure the check to report file names that contain a space:

 <module name="RegexpOnFilename"/>
 

Example:

 src/xdocs/config_regexp.xml  //OK, contains no whitespace
 src/xdocs/"config regexp".xml  //violation, contains whitespace
 

To configure the check to forbid 'gif' files in folders:

 <module name="RegexpOnFilename">
   <property name="fileNamePattern" value="\.gif$"/>
 </module>
 

Example:

 src/site/resources/images/favicon.png  //OK
 src/site/resources/images/logo.jpg  //OK
 src/site/resources/images/groups.gif  //violation, .gif images not allowed
 

To configure the check to forbid 'md' files except 'README.md file' in folders, with custom message:

 <module name="RegexpOnFilename">
   <property name="fileNamePattern" value="README"/>
   <property name="fileExtensions" value="md"/>
   <property name="match" value="false"/>
   <message key="regexp.filename.mismatch"
     value="No '*.md' files other then 'README.md'"/>
 </module>
 

Example:

 src/site/resources/README.md  //OK
 src/site/resources/Logo.png  //OK
 src/site/resources/Text.md  //violation, .md files other than 'README.md' are not allowed
 

To configure the check to only allow property and xml files to be located in the resource folder:

 <module name="RegexpOnFilename">
   <property name="folderPattern"
     value="[\\/]src[\\/]\w+[\\/]resources[\\/]"/>
   <property name="match" value="false"/>
   <property name="fileExtensions" value="properties, xml"/>
 </module>
 

Example:

 src/main/resources/sun_checks.xml  //OK
 src/main/resources/check_properties.properties  //OK
 src/main/resources/JavaClass.java  //violation, xml|property files are allowed in resource folder
 

To configure the check to only allow Java and XML files in your folders use the below.

 <module name="RegexpOnFilename">
   <property name="fileNamePattern" value="\.(java|xml)$"/>
   <property name="match" value="false"/>
 </module>
 

Example:

 src/main/java/JavaClass.java  //OK
 src/main/MainClass.java  //OK
 src/main/java/java_xml.xml  //OK
 src/main/main_xml.xml  //OK
 src/main/java/image.png  //violation, folders should only contain java or xml files
 src/main/check_properties.properties  //violation, folders should only contain java or xml files
 

To configure the check to only allow Java and XML files only in your source folder and ignore any other folders:

 <module name="RegexpOnFilename">
   <property name="folderPattern" value="[\\/]src[\\/]"/>
   <property name="fileNamePattern" value="\.(java|xml)$"/>
   <property name="match" value="false"/>
 </module>
 

Example:

 src/SourceClass.java  //OK
 src/source_xml.xml  //OK
 src/image.png  //violation, only java and xml files are allowed in src folder
 src/main/main_properties.properties  //OK, this check only applies to src folder
 

Note: 'folderPattern' must be specified if checkstyle is analyzing more than the normal source folder, like the 'bin' folder where class files can be located.

To configure the check to only allow file names to be camel case:

 <module name="RegexpOnFilename">
   <property name="fileNamePattern" value="^([A-Z][a-z0-9]+\.?)+$"/>
   <property name="match" value="false"/>
   <property name="ignoreFileNameExtensions" value="true"/>
 </module>
 

Example:

 src/main/java/JavaClass.java  //OK
 src/main/MainClass.java  //OK
 src/main/java/java_class.java  //violation, file names should be in Camel Case
 src/main/main_class.java  //violation, file names should be in Camel Case
 

Parent is com.puppycrawl.tools.checkstyle.Checker

Violation Message Keys:

• regexp.filename.match
• regexp.filename.mismatch

Since:

6.15

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_MATCH A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_MISMATCH A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
RegexpOnFilenameCheck()

Method Summary

Modifier and Type	Method and Description
void	init() Initialise the instance.
protected void	processFiltered(File file, FileText fileText) Called to process a file that matches the specified file extensions.
void	setFileNamePattern(Pattern fileNamePattern) Setter to specify the regular expression to match the file name against.
void	setFolderPattern(Pattern folderPattern) Setter to specify the regular expression to match the folder path against.
void	setIgnoreFileNameExtensions(boolean ignoreFileNameExtensions) Setter to control whether to ignore the file extension for the file name match.
void	setMatch(boolean match) Setter to control whether to look for a match or mis-match on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getMessages, getTabWidth, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable

configure

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable

contextualize

Field Detail

MSG_MATCH

public static final String MSG_MATCH

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_MISMATCH

public static final String MSG_MISMATCH

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

RegexpOnFilenameCheck

public RegexpOnFilenameCheck()

Method Detail

setFolderPattern

public void setFolderPattern(Pattern folderPattern)

Setter to specify the regular expression to match the folder path against.

Parameters:

folderPattern - format of folder.

setFileNamePattern

public void setFileNamePattern(Pattern fileNamePattern)

Setter to specify the regular expression to match the file name against.

Parameters:

fileNamePattern - format of file.

setMatch

public void setMatch(boolean match)

Setter to control whether to look for a match or mis-match on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.

Parameters:

match - check's option for matching file names.

setIgnoreFileNameExtensions

public void setIgnoreFileNameExtensions(boolean ignoreFileNameExtensions)

Setter to control whether to ignore the file extension for the file name match.

Parameters:

ignoreFileNameExtensions - check's option for ignoring file extension.

init

public void init()

Description copied from interface: FileSetCheck

Initialise the instance. This is the time to verify that everything required to perform it job.

Specified by:

init in interface FileSetCheck

Overrides:

init in class AbstractFileSetCheck

processFiltered

protected void processFiltered(File file,
                               FileText fileText)
                        throws CheckstyleException

Description copied from class: AbstractFileSetCheck

Called to process a file that matches the specified file extensions.

Specified by:

processFiltered in class AbstractFileSetCheck

Parameters:

file - the file to be processed

fileText - the contents of the file.

Throws:

CheckstyleException - if error condition within Checkstyle occurs.