/* * SonarQube Java * Copyright (C) 2012-2016 SonarSource SA * mailto:contact AT sonarsource DOT com * * 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 02110-1301, USA. */ package org.sonar.java.checks; import com.google.common.collect.Lists; import org.sonar.check.Rule; import org.sonar.java.JavaVersionAwareVisitor; import org.sonar.java.resolve.JavaSymbol; import org.sonar.plugins.java.api.JavaFileScanner; import org.sonar.plugins.java.api.JavaFileScannerContext; import org.sonar.plugins.java.api.JavaVersion; import org.sonar.plugins.java.api.tree.BaseTreeVisitor; import org.sonar.plugins.java.api.tree.ClassTree; import org.sonar.plugins.java.api.tree.EnumConstantTree; import org.sonar.plugins.java.api.tree.IdentifierTree; import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree; import org.sonar.plugins.java.api.tree.MethodTree; import org.sonar.plugins.java.api.tree.NewClassTree; import org.sonar.plugins.java.api.tree.Tree; import org.sonar.plugins.java.api.tree.TypeTree; import java.util.List; @Rule(key = "S1604") public class AnonymousClassShouldBeLambdaCheck extends BaseTreeVisitor implements JavaFileScanner, JavaVersionAwareVisitor { private JavaFileScannerContext context; private List<IdentifierTree> enumConstants; @Override public boolean isCompatibleWithJavaVersion(JavaVersion version) { return version.isJava8Compatible(); } @Override public void scanFile(JavaFileScannerContext context) { this.context = context; enumConstants = Lists.newArrayList(); scan(context.getTree()); } @Override public void visitEnumConstant(EnumConstantTree tree) { enumConstants.add(tree.simpleName()); super.visitEnumConstant(tree); enumConstants.remove(tree.simpleName()); } @Override public void visitNewClass(NewClassTree tree) { super.visitNewClass(tree); ClassTree classBody = tree.classBody(); if (classBody != null) { TypeTree identifier = tree.identifier(); if (!useThisIdentifier(classBody) && !enumConstants.contains(identifier) && isSAM(classBody)) { context.reportIssue(this, identifier, "Make this anonymous inner class a lambda" + context.getJavaVersion().java8CompatibilityMessage()); } } } private static boolean isSAM(ClassTree classBody) { if(hasOnlyOneMethod(classBody.members()) && classBody.symbol().isTypeSymbol()) { // Verify class body is a subtype of an interface JavaSymbol.TypeJavaSymbol symbol = (JavaSymbol.TypeJavaSymbol) classBody.symbol(); return symbol.getInterfaces().size() == 1 && symbol.getSuperclass().is("java.lang.Object"); } return false; } private static boolean hasOnlyOneMethod(List<Tree> members) { MethodTree methodTree = null; for (Tree tree : members) { if (!tree.is(Tree.Kind.EMPTY_STATEMENT, Tree.Kind.METHOD)) { return false; } else if (tree.is(Tree.Kind.METHOD)) { if (methodTree != null) { return false; } methodTree = (MethodTree) tree; } } // if overriden method declares to throw an exception, refactoring to a lambda might prove tricky return methodTree != null && methodTree.throwsClauses().isEmpty(); } private static boolean useThisIdentifier(ClassTree body) { ThisIdentifierVisitor visitor = new ThisIdentifierVisitor(); body.accept(visitor); return visitor.usesThisIdentifier; } private static class ThisIdentifierVisitor extends BaseTreeVisitor { boolean usesThisIdentifier = false; boolean visitedClassTree = false; @Override public void visitClass(ClassTree tree) { // visit the class body but ignore inner classes if (!visitedClassTree) { visitedClassTree = true; super.visitClass(tree); } } @Override public void visitNewClass(NewClassTree tree) { // ignore anonymous classes } @Override public void visitMemberSelectExpression(MemberSelectExpressionTree tree) { scan(tree.expression()); // ignore identifier, because if it is this, it is a qualified this. } @Override public void visitIdentifier(IdentifierTree tree) { usesThisIdentifier |= "this".equals(tree.name()); } } }