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.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026
027/**
028 * Detects inline conditionals.
029 *
030 * <p>An example inline conditional is this:
031 * <pre>
032 * String a = getParameter("a");
033 * String b = (a==null || a.length&lt;1) ? null : a.substring(1);
034 * </pre>
035 * Rationale: Some developers find inline conditionals hard to read,
036 * so their company's coding standards forbids them.
037 *
038 * @author lkuehne
039 */
040@StatelessCheck
041public class AvoidInlineConditionalsCheck extends AbstractCheck {
042
043    /**
044     * A key is pointing to the warning message text in "messages.properties"
045     * file.
046     */
047    public static final String MSG_KEY = "inline.conditional.avoid";
048
049    @Override
050    public int[] getDefaultTokens() {
051        return getRequiredTokens();
052    }
053
054    @Override
055    public int[] getRequiredTokens() {
056        return new int[] {TokenTypes.QUESTION};
057    }
058
059    @Override
060    public int[] getAcceptableTokens() {
061        return getRequiredTokens();
062    }
063
064    @Override
065    public void visitToken(DetailAST ast) {
066        // the only place a QUESTION token can occur is in inline conditionals
067        // so no need to do any further tricks here - pretty trivial Check!
068
069        log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY);
070    }
071}