1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.coding;
21
22 import java.util.BitSet;
23 import java.util.function.Predicate;
24
25 import com.puppycrawl.tools.checkstyle.StatelessCheck;
26 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
27 import com.puppycrawl.tools.checkstyle.api.DetailAST;
28 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
29 import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
30
31 /**
32 * <div>
33 * Detects double brace initialization.
34 * </div>
35 *
36 * <p>
37 * Rationale: Double brace initialization (set of
38 * <a href="https://docs.oracle.com/javase/specs/jls/se12/html/jls-8.html#jls-8.6">
39 * Instance Initializers</a> in class body) may look cool, but it is considered as anti-pattern
40 * and should be avoided.
41 * This is also can lead to a hard-to-detect memory leak, if the anonymous class instance is
42 * returned outside and other object(s) hold reference to it.
43 * Created anonymous class is not static, it holds an implicit reference to the outer class
44 * instance.
45 * See this
46 * <a href="https://blog.jooq.org/dont-be-clever-the-double-curly-braces-anti-pattern/">
47 * blog post</a> and
48 * <a href="https://www.baeldung.com/java-double-brace-initialization">
49 * article</a> for more details.
50 * Check ignores any comments and semicolons in class body.
51 * </p>
52 *
53 * <p>
54 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
55 * </p>
56 *
57 * <p>
58 * Violation Message Keys:
59 * </p>
60 * <ul>
61 * <li>
62 * {@code avoid.double.brace.init}
63 * </li>
64 * </ul>
65 *
66 * @since 8.30
67 */
68 @StatelessCheck
69 public class AvoidDoubleBraceInitializationCheck extends AbstractCheck {
70
71 /**
72 * A key is pointing to the warning message text in "messages.properties"
73 * file.
74 */
75 public static final String MSG_KEY = "avoid.double.brace.init";
76
77 /**
78 * Set of token types that are used in {@link #HAS_MEMBERS} predicate.
79 */
80 private static final BitSet IGNORED_TYPES = TokenUtil.asBitSet(
81 TokenTypes.INSTANCE_INIT,
82 TokenTypes.SEMI,
83 TokenTypes.LCURLY,
84 TokenTypes.RCURLY
85 );
86
87 /**
88 * Predicate for tokens that is used in {@link #hasOnlyInitialization(DetailAST)}.
89 */
90 private static final Predicate<DetailAST> HAS_MEMBERS =
91 token -> !IGNORED_TYPES.get(token.getType());
92
93 @Override
94 public int[] getDefaultTokens() {
95 return getRequiredTokens();
96 }
97
98 @Override
99 public int[] getAcceptableTokens() {
100 return getRequiredTokens();
101 }
102
103 @Override
104 public int[] getRequiredTokens() {
105 return new int[] {TokenTypes.OBJBLOCK};
106 }
107
108 @Override
109 public void visitToken(DetailAST ast) {
110 if (ast.getParent().getType() == TokenTypes.LITERAL_NEW
111 && hasOnlyInitialization(ast)) {
112 log(ast, MSG_KEY);
113 }
114 }
115
116 /**
117 * Checks that block has at least one instance init block and no other class members.
118 *
119 * @param objBlock token to check
120 * @return true if there is least one instance init block and no other class members,
121 * false otherwise
122 */
123 private static boolean hasOnlyInitialization(DetailAST objBlock) {
124 final boolean hasInitBlock = objBlock.findFirstToken(TokenTypes.INSTANCE_INIT) != null;
125 return hasInitBlock
126 && TokenUtil.findFirstTokenByPredicate(objBlock, HAS_MEMBERS).isEmpty();
127 }
128 }