| //////////////////////////////////////////////////////////////////////////////// |
| // checkstyle: Checks Java source code for adherence to a set of rules. |
| // Copyright (C) 2001-2017 the original author or authors. |
| // |
| // This library is free software; you can redistribute it and/or |
| // modify it under the terms of the GNU Lesser General Public |
| // License as published by the Free Software Foundation; either |
| // version 2.1 of the License, or (at your option) any later version. |
| // |
| // This library is distributed in the hope that it will be useful, |
| // but WITHOUT ANY WARRANTY; without even the implied warranty of |
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| // Lesser General Public License for more details. |
| // |
| // You should have received a copy of the GNU Lesser General Public |
| // License along with this library; if not, write to the Free Software |
| // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package com.puppycrawl.tools.checkstyle.checks.coding; |
| |
| import antlr.collections.AST; |
| import com.puppycrawl.tools.checkstyle.StatelessCheck; |
| import com.puppycrawl.tools.checkstyle.api.AbstractCheck; |
| import com.puppycrawl.tools.checkstyle.api.DetailAST; |
| import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
| |
| /** |
| * <p>Checks that string literals are not used with |
| * {@code ==} or {@code !=}. |
| * </p> |
| * <p> |
| * Rationale: Novice Java programmers often use code like |
| * {@code if (x == "something")} when they mean |
| * {@code if ("something".equals(x))}. |
| * </p> |
| * |
| * @author Lars Kühne |
| */ |
| @StatelessCheck |
| public class StringLiteralEqualityCheck extends AbstractCheck { |
| |
| /** |
| * A key is pointing to the warning message text in "messages.properties" |
| * file. |
| */ |
| public static final String MSG_KEY = "string.literal.equality"; |
| |
| @Override |
| public int[] getDefaultTokens() { |
| return getRequiredTokens(); |
| } |
| |
| @Override |
| public int[] getAcceptableTokens() { |
| return getRequiredTokens(); |
| } |
| |
| @Override |
| public int[] getRequiredTokens() { |
| return new int[] {TokenTypes.EQUAL, TokenTypes.NOT_EQUAL}; |
| } |
| |
| @Override |
| public void visitToken(DetailAST ast) { |
| // no need to check for nulls here, == and != always have two children |
| final AST firstChild = ast.getFirstChild(); |
| final AST secondChild = firstChild.getNextSibling(); |
| |
| if (firstChild.getType() == TokenTypes.STRING_LITERAL |
| || secondChild.getType() == TokenTypes.STRING_LITERAL) { |
| log(ast.getLineNo(), ast.getColumnNo(), |
| MSG_KEY, ast.getText()); |
| } |
| } |
| } |