com.puppycrawl.tools.checkstyle.checks.coding

Class PackageDeclarationCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public final class PackageDeclarationCheck
extends Check

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.

Author:

Simon Harris, Oliver Burn

Constructor Summary

Constructors

Constructor and Description
PackageDeclarationCheck()

Method Summary

Methods

Modifier and Type	Method and Description
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	setIgnoreDirectoryName(boolean aValue) Set whether to ignore checking the directory name.
void	visitToken(DetailAST aAST) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

PackageDeclarationCheck

public PackageDeclarationCheck()

Method Detail

setIgnoreDirectoryName

public void setIgnoreDirectoryName(boolean aValue)

Set whether to ignore checking the directory name.

Parameters:

aValue - the new value.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

beginTree

public void beginTree(DetailAST aAST)

Description copied from class: Check

Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.

Overrides:

beginTree in class Check

Parameters:

aAST - the root of the tree

finishTree

public void finishTree(DetailAST aAST)

Description copied from class: Check

Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

Overrides:

finishTree in class Check

Parameters:

aAST - the root of the tree

visitToken

public void visitToken(DetailAST aAST)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

aAST - the token to process