|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.coding.PackageDeclarationCheck
Ensures there is a package declaration. Rationale: Classes that live in the null package cannot be imported. Many novice developers are not aware of this.
Constructor Summary | |
PackageDeclarationCheck()
|
Method Summary | |
void |
beginTree(DetailAST aAST)
Called before the starting to process a tree. |
void |
finishTree(DetailAST aAST)
Called after finished processing a tree. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
int[] |
getRequiredTokens()
The tokens that this check must be registered for. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PackageDeclarationCheck()
Method Detail |
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
Check
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
Check
public void beginTree(DetailAST aAST)
Check
beginTree
in class Check
aAST
- the root of the treeCheck
public void finishTree(DetailAST aAST)
Check
finishTree
in class Check
aAST
- the root of the treeCheck
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processCheck
|
Back to the Checkstyle Home Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |