public class OneTopLevelClassCheck extends AbstractCheck
Checks that each top-level class, interface, enum or annotation 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, interface, enum or annotation, top-level type is the first type in file.
To configure the check:
<module name="OneTopLevelClass"/>
ATTENTION: This Check does not support customization of validated tokens, so do not use the "tokens" property.
An example of code with violations:
public class Foo { // OK, first top-level class
// methods
}
class Foo2 { // violation, second top-level class
// methods
}
An example of code without public top-level type:
class Foo { // OK, first top-level class
// methods
}
class Foo2 { // violation, second top-level class
// methods
}
An example of code without violations:
public class Foo { // OK, only one top-level class
// methods
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
one.top.level.class
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
OneTopLevelClassCheck() |
| Modifier and Type | Method and Description |
|---|---|
void |
beginTree(DetailAST rootAST)
Called before the starting to process 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.
|
clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens, visitTokenfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final String MSG_KEY
public OneTopLevelClassCheck()
public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void beginTree(DetailAST rootAST)
AbstractCheckbeginTree in class AbstractCheckrootAST - the root of the treeCopyright © 2001–2020. All rights reserved.