View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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   * Detects inline conditionals.
29   *
30   * <p>An example inline conditional is this:
31   * <pre>
32   * String a = getParameter("a");
33   * String b = (a==null || a.length&lt;1) ? null : a.substring(1);
34   * </pre>
35   * Rationale: Some developers find inline conditionals hard to read,
36   * so their company's coding standards forbids them.
37   *
38   * @author lkuehne
39   */
40  @StatelessCheck
41  public class AvoidInlineConditionalsCheck extends AbstractCheck {
42  
43      /**
44       * A key is pointing to the warning message text in "messages.properties"
45       * file.
46       */
47      public static final String MSG_KEY = "inline.conditional.avoid";
48  
49      @Override
50      public int[] getDefaultTokens() {
51          return getRequiredTokens();
52      }
53  
54      @Override
55      public int[] getRequiredTokens() {
56          return new int[] {TokenTypes.QUESTION};
57      }
58  
59      @Override
60      public int[] getAcceptableTokens() {
61          return getRequiredTokens();
62      }
63  
64      @Override
65      public void visitToken(DetailAST ast) {
66          // the only place a QUESTION token can occur is in inline conditionals
67          // so no need to do any further tricks here - pretty trivial Check!
68  
69          log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY);
70      }
71  }