001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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 * <div>
029 * Detects inline conditionals. Here is one example of an inline conditional:
030 * </div>
031 * <div class="wrapper"><pre class="prettyprint"><code class="language-java">
032 * String a = getParameter("a");
033 * String b = (a==null || a.length()&lt;1) ? null : a.substring(1);
034 * </code></pre></div>
035 *
036 * <p>
037 * Rationale: Some developers find inline conditionals hard to read, so
038 * their employer's coding standards forbid them.
039 * </p>
040 *
041 * @since 3.1
042 */
043@StatelessCheck
044public class AvoidInlineConditionalsCheck extends AbstractCheck {
045
046    /**
047     * A key is pointing to the warning message text in "messages.properties"
048     * file.
049     */
050    public static final String MSG_KEY = "inline.conditional.avoid";
051
052    /**
053     * Creates a new {@code AvoidInlineConditionalsCheck} instance.
054     */
055    public AvoidInlineConditionalsCheck() {
056        // no code by default
057    }
058
059    @Override
060    public int[] getDefaultTokens() {
061        return getRequiredTokens();
062    }
063
064    @Override
065    public int[] getRequiredTokens() {
066        return new int[] {TokenTypes.QUESTION};
067    }
068
069    @Override
070    public int[] getAcceptableTokens() {
071        return getRequiredTokens();
072    }
073
074    @Override
075    public void visitToken(DetailAST ast) {
076        // the only place a QUESTION token can occur is in inline conditionals
077        // so no need to do any further tricks here - pretty trivial Check!
078
079        log(ast, MSG_KEY);
080    }
081
082}