Package com.puppycrawl.tools.checkstyle.checks.sizes

Class OuterTypeNumberCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class OuterTypeNumberCheck
extends AbstractCheck

Checks for the number of types declared at the outer (or root) level in a file.

Rationale: It is considered good practice to only define one outer type per file.

• Property max - Specify the maximum number of outer types allowed. Type is int. Default value is 1.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• maxOuterTypes

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private int	currentDepth	Tracks the current depth in types.
private int	max	Specify the maximum number of outer types allowed.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.
private int	outerNum	Tracks the number of outer types found.

Constructor Summary

Constructors

Constructor	Description
OuterTypeNumberCheck()

Method Summary

Modifier and Type	Method	Description
void	beginTree(DetailAST ast)	Called before the starting to process a tree.
void	finishTree(DetailAST ast)	Called after finished processing a tree.
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
void	leaveToken(DetailAST ast)	Called after all the child nodes have been process.
void	setMax(int max)	Setter to specify the maximum number of outer types allowed.
void	visitToken(DetailAST ast)	Called to process a token.

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

clearViolations, destroy, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

max

private int max

Specify the maximum number of outer types allowed.

currentDepth

private int currentDepth

Tracks the current depth in types.

outerNum

private int outerNum

Tracks the number of outer types found.

Constructor Details

OuterTypeNumberCheck

public OuterTypeNumberCheck()

Method Details

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

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 AbstractCheck

Returns:

the default tokens

See Also:

• TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

• TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

beginTree

public void beginTree(DetailAST ast)

Description copied from class: AbstractCheck

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

Overrides:

beginTree in class AbstractCheck

Parameters:

ast - the root of the tree

finishTree

public void finishTree(DetailAST ast)

Description copied from class: AbstractCheck

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

Overrides:

finishTree in class AbstractCheck

Parameters:

ast - the root of the tree

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

leaveToken

public void leaveToken(DetailAST ast)

Description copied from class: AbstractCheck

Called after all the child nodes have been process.

Overrides:

leaveToken in class AbstractCheck

Parameters:

ast - the token leaving

setMax

public void setMax(int max)

Setter to specify the maximum number of outer types allowed.

Parameters:

max - the new number.

Since:

5.0