public class AvoidDoubleBraceInitializationCheck extends AbstractCheck
Detects double brace initialization.
Rationale: Double brace initialization (set of Instance Initializers in class body) may look cool, but it is considered as anti-pattern and should be avoided. This is also can lead to a hard-to-detect memory leak, if the anonymous class instance is returned outside and other object(s) hold reference to it. Created anonymous class is not static, it holds an implicit reference to the outer class instance. See this blog post and article for more details. Check ignores any comments and semicolons in class body.
To configure the check:
<module name="AvoidDoubleBraceInitialization"/>
Which results in the following violations:
class MyClass {
List<Integer> list1 = new ArrayList<>() { // violation
{
add(1);
}
};
List<String> list2 = new ArrayList<>() { // violation
;
// comments and semicolons are ignored
{
add("foo");
}
};
}
Check only looks for double brace initialization and it ignores cases where the anonymous class has fields or methods. Though these might create the same memory issues as double brace, the extra class members can produce side effects if changed incorrectly.
class MyClass {
List<Object> list = new ArrayList<>() { // OK, not pure double brace pattern
private int field;
{
add(new Object());
}
};
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
avoid.double.brace.init
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
private static java.util.function.Predicate<DetailAST> |
HAS_MEMBERS
Predicate for tokens that is used in
hasOnlyInitialization(DetailAST). |
private static java.util.List<java.lang.Integer> |
IGNORED_TYPES
List of token types that are used in
HAS_MEMBERS predicate. |
static java.lang.String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
AvoidDoubleBraceInitializationCheck() |
| 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.
|
private static boolean |
hasOnlyInitialization(DetailAST objBlock)
Checks that block has at least one instance init block and no other class members.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String MSG_KEY
private static final java.util.List<java.lang.Integer> IGNORED_TYPES
HAS_MEMBERS predicate.private static final java.util.function.Predicate<DetailAST> HAS_MEMBERS
hasOnlyInitialization(DetailAST).public AvoidDoubleBraceInitializationCheck()
public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processprivate static boolean hasOnlyInitialization(DetailAST objBlock)
objBlock - token to checkCopyright © 2001-2022. All Rights Reserved.