public class NoEnumTrailingCommaCheck extends AbstractCheck
Checks that enum definition does not contain a trailing comma. Rationale: JLS allows trailing commas in arrays and enumerations, but does not allow them in other locations. To unify the coding style, the use of trailing commas should be prohibited.
enum Foo1 {
FOO,
BAR;
}
The check demands that there should not be any comma after last constant in enum definition.
enum Foo1 {
FOO,
BAR, //violation
}
To configure the check:
<module name="NoEnumTrailingComma"/>
Which results in the following violations:
enum Foo1 {
FOO,
BAR; //OK
}
enum Foo2 {
FOO,
BAR //OK
}
enum Foo3 {
FOO,
BAR, //violation
}
enum Foo4 {
FOO,
BAR, // violation
;
}
enum Foo5 {
FOO,
BAR,; // violation
}
enum Foo6 { FOO, BAR,; } // violation
enum Foo7 { FOO, BAR, } // violation
enum Foo8 {
FOO,
BAR // OK
;
}
enum Foo9 { FOO, BAR; } // OK
enum Foo10 { FOO, BAR } // OK
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
no.enum.trailing.comma
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 |
|---|
NoEnumTrailingCommaCheck() |
| Modifier and Type | Method and Description |
|---|---|
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 |
visitToken(DetailAST detailAST)
Called to process a token.
|
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final String MSG_KEY
public NoEnumTrailingCommaCheck()
public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST detailAST)
AbstractCheckvisitToken in class AbstractCheckdetailAST - the token to processCopyright © 2001–2020. All rights reserved.