001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.coding;
021
022import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
023import com.puppycrawl.tools.checkstyle.api.DetailAST;
024import com.puppycrawl.tools.checkstyle.api.TokenTypes;
025
026/**
027 * Detects inline conditionals.
028 *
029 * <p>An example inline conditional is this:
030 * <pre>
031 * String a = getParameter("a");
032 * String b = (a==null || a.length&lt;1) ? null : a.substring(1);
033 * </pre>
034 * Rationale: Some developers find inline conditionals hard to read,
035 * so their company's coding standards forbids them.
036 *
037 * @author lkuehne
038 */
039public class AvoidInlineConditionalsCheck extends AbstractCheck {
040
041    /**
042     * A key is pointing to the warning message text in "messages.properties"
043     * file.
044     */
045    public static final String MSG_KEY = "inline.conditional.avoid";
046
047    @Override
048    public int[] getDefaultTokens() {
049        return new int[] {TokenTypes.QUESTION};
050    }
051
052    @Override
053    public int[] getRequiredTokens() {
054        return getDefaultTokens();
055    }
056
057    @Override
058    public int[] getAcceptableTokens() {
059        return new int[] {TokenTypes.QUESTION};
060    }
061
062    @Override
063    public void visitToken(DetailAST ast) {
064        // the only place a QUESTION token can occur is in inline conditionals
065        // so no need to do any further tricks here - pretty trivial Check!
066
067        log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY);
068    }
069}