Description

The default value of format for module PackageName 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 configurations should probably assign value ^[a-z]+(\.[a-z][a-z0-9]*)*$ to format for module PackageName.

Properties

Examples

To configure the check:

<module name="Checker">
  <module name="TreeWalker">
    <module name="PackageName"/>
  </module>
</module>
        

Code Example:

package com.puppycrawl.tools.checkstyle.checks.naming.packagename;

public class Example1 {
}
        

An example of how to configure the check to ensure with packages start with a upper case letter and only contains lowercase letters or numbers is:

<module name="Checker">
  <module name="TreeWalker">
    <module name="PackageName">
      <property name="format"
        value="^[A-Z]+(\.[a-z][a-z0-9]*)*$"/>
    </module>
  </module>
</module>
        

Code Example:

package com.puppycrawl.tools.checkstyle.checks.naming.packagename;
// violation above 'must match pattern'

public class Example2 {
}
        

Example of Usage

• Google Style
• Sun Style
• Checkstyle Style

Violation Messages

• name.invalidPattern

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.naming

Parent Module

TreeWalker