Class OneTopLevelClassCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class OneTopLevelClassCheck extends AbstractCheck
Checks that each top-level class, interface or enum resides in a source file of its own.Official description of a 'top-level' term: 7.6. Top Level Type Declarations. If file doesn't contains public class, enum or interface, top-level type is the first type in file.
An example of code with violations:
public class Foo{ //methods } class Foo2{ //methods }
An example of code without top-level public type:
class Foo{ //top-level class //methods } class Foo2{ //methods }
An example of check's configuration:
<module name="OneTopLevelClass"/>
An example of code without violations:
public class Foo{ //methods }
ATTENTION: This Check does not support customization of validated tokens, so do not use the "tokens" property.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.SortedMap<java.lang.Integer,java.lang.String>
lineNumberTypeMap
Mapping between type names and line numbers of the type declarations.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.private boolean
publicTypeFound
True if a java source file contains a type with a public access level modifier.
-
Constructor Summary
Constructors Constructor Description OneTopLevelClassCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.void
finishTree(DetailAST rootAST)
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.private static boolean
isPublic(DetailAST typeDef)
Checks if a type is public.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken
-
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
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
publicTypeFound
private boolean publicTypeFound
True if a java source file contains a type with a public access level modifier.
-
lineNumberTypeMap
private final java.util.SortedMap<java.lang.Integer,java.lang.String> lineNumberTypeMap
Mapping between type names and line numbers of the type declarations.
-
-
Method Detail
-
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
beginTree
public void beginTree(DetailAST rootAST)
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 classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
finishTree
public void finishTree(DetailAST rootAST)
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 classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
isPublic
private static boolean isPublic(DetailAST typeDef)
Checks if a type is public.- Parameters:
typeDef
- type definition node.- Returns:
- true if a type has a public access level modifier.
-
-