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