public class PackageNameCheck extends AbstractFormatCheck
Checks that package names conform to a format specified
by the format property. The format is a
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 and Description |
---|
PackageNameCheck()
Creates a new
PackageNameCheck instance. |
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
getFormat, getRegexp, setCompileFlags, setFormat
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public PackageNameCheck()
PackageNameCheck
instance.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2015. All rights reserved.