1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 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 com.puppycrawl.tools.checkstyle.StatelessCheck;
23 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24 import com.puppycrawl.tools.checkstyle.api.DetailAST;
25 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
26
27 /**
28 * <div>
29 * Detects inline conditionals. Here is one example of an inline conditional:
30 * </div>
31 * {@snippet lang="text" :
32 * String a = getParameter("a");
33 * String b = (a==null || a.length() > 1) ? null : a.substring(1);
34 * }
35 *
36 * <p>
37 * Rationale: Some developers find inline conditionals hard to read, so
38 * their employer's coding standards forbid them.
39 * </p>
40 *
41 * @since 3.1
42 */
43 @StatelessCheck
44 public class AvoidInlineConditionalsCheck extends AbstractCheck {
45
46 /**
47 * A key is pointing to the warning message text in "messages.properties"
48 * file.
49 */
50 public static final String MSG_KEY = "inline.conditional.avoid";
51
52 /**
53 * Creates a new {@code AvoidInlineConditionalsCheck} instance.
54 */
55 public AvoidInlineConditionalsCheck() {
56 // no code by default
57 }
58
59 @Override
60 public int[] getDefaultTokens() {
61 return getRequiredTokens();
62 }
63
64 @Override
65 public int[] getRequiredTokens() {
66 return new int[] {TokenTypes.QUESTION};
67 }
68
69 @Override
70 public int[] getAcceptableTokens() {
71 return getRequiredTokens();
72 }
73
74 @Override
75 public void visitToken(DetailAST ast) {
76 // the only place a QUESTION token can occur is in inline conditionals
77 // so no need to do any further tricks here - pretty trivial Check!
78
79 log(ast, MSG_KEY);
80 }
81
82 }