Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck
public class PackageNameCheck
extends AbstractFormatCheck
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>
Constructor Summary | |
|
Method Summary | |
int[] | |
void |
|
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck | |
getFormat , getRegexp , setCompileFlags , setFormat |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check | |
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter | |
getId , getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setId , setSeverity |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean | |
configure , contextualize , finishLocalSetup , getConfiguration , setupChild |
Back to the Checkstyle Home Page |