org.sonar.java.checks.ConcatenationWithStringValueOfCheck Maven / Gradle / Ivy
The newest version!
/*
* SonarQube Java
* Copyright (C) 2012 SonarSource
* [email protected]
*
* This program 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 3 of the License, or (at your option) any later version.
*
* This program 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 program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.java.checks;
import com.google.common.collect.Sets;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.plugins.java.api.JavaFileScanner;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
import org.sonar.plugins.java.api.tree.BinaryExpressionTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
import org.sonar.plugins.java.api.tree.Tree.Kind;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
import java.util.Set;
@Rule(
key = "S1153",
name = "String.valueOf() should not be appended to a String",
tags = {"clumsy"},
priority = Priority.MINOR)
@ActivatedByDefault
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.READABILITY)
@SqaleConstantRemediation("5min")
public class ConcatenationWithStringValueOfCheck extends BaseTreeVisitor implements JavaFileScanner {
private JavaFileScannerContext context;
@Override
public void scanFile(JavaFileScannerContext context) {
this.context = context;
scan(context.getTree());
}
@Override
public void visitBinaryExpression(BinaryExpressionTree tree) {
if (!tree.is(Kind.PLUS)) {
super.visitBinaryExpression(tree);
return;
}
Set valueOfTrees = Sets.newHashSet();
boolean flagIssue = false;
ExpressionTree current = tree;
while (current.is(Kind.PLUS)) {
BinaryExpressionTree binOp = (BinaryExpressionTree) current;
scan(binOp.rightOperand());
if (isStringValueOf(binOp.rightOperand())) {
valueOfTrees.add(binOp.rightOperand());
}
flagIssue |= binOp.leftOperand().is(Kind.STRING_LITERAL);
if (!valueOfTrees.isEmpty()) {
flagIssue |= binOp.rightOperand().is(Kind.STRING_LITERAL);
}
current = ((BinaryExpressionTree) current).leftOperand();
}
if (flagIssue) {
for (ExpressionTree valueOfTree : valueOfTrees) {
addIssue(valueOfTree);
}
}
scan(current);
}
private void addIssue(ExpressionTree tree) {
context.addIssue(tree, this, "Directly append the argument of String.valueOf().");
}
private static boolean isStringValueOf(ExpressionTree tree) {
if (!tree.is(Kind.METHOD_INVOCATION)) {
return false;
}
return isStringValueOf((MethodInvocationTree) tree);
}
private static boolean isStringValueOf(MethodInvocationTree tree) {
if (!tree.methodSelect().is(Kind.MEMBER_SELECT)) {
return false;
}
return tree.arguments().size() == 1 &&
isStringValueOf((MemberSelectExpressionTree) tree.methodSelect());
}
private static boolean isStringValueOf(MemberSelectExpressionTree tree) {
if (!tree.expression().is(Kind.IDENTIFIER)) {
return false;
}
return "valueOf".equals(tree.identifier().name()) &&
"String".equals(((IdentifierTree) tree.expression()).name());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy