Class PackageNameCheck

Checks that package names conform to a format specified by the format property. The format is a java.util.regex.Pattern regular expression and defaults to ^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9]*)*$.

The default format has been chosen to match the requirements in the Java Language specification and the Sun coding conventions. However both underscores and uppercase letters are rather uncommon, so most projects should probably use ^[a-z]+(\.[a-z][a-z0-9]*)*$.

An example of how to configure the check is:

 <module name="PackageName"/>
 

An example of how to configure the check for package names that begin with com.puppycrawl.tools.checkstyle is:

 <module name="PackageName">
    <property name="format"
              value="^com\.puppycrawl\.tools\.checkstyle(\\.[a-zA-Z_][a-zA-Z_0-9]*)*$"/>
 </module>
 

Version: 1.0

Author: Oliver Burn