org.sonar.java.checks.InterfaceOrSuperclassShadowingCheck Maven / Gradle / Ivy

Go to download
/*
 * 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.ImmutableList;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.java.model.declaration.ClassTreeImpl;
import org.sonar.java.resolve.Symbol.TypeSymbol;
import org.sonar.java.resolve.Type;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.Tree.Kind;

import java.util.List;

@Rule(
  key = "S2176",
  priority = Priority.MAJOR,
  tags = {"pitfall"})
@BelongsToProfile(title = "Sonar way", priority = Priority.MAJOR)
public class InterfaceOrSuperclassShadowingCheck extends SubscriptionBaseVisitor {

  @Override
  public List nodesToVisit() {
    return ImmutableList.of(Tree.Kind.CLASS, Tree.Kind.INTERFACE);
  }

  @Override
  public void visitNode(Tree tree) {
    ClassTreeImpl classTree = (ClassTreeImpl) tree;
    if (hasSemantic()) {
      TypeSymbol classSymbol = classTree.getSymbol();
      checkSuperType(classTree, classSymbol.getSuperclass());
      for (Type interfaceType : classSymbol.getInterfaces()) {
        checkSuperType(classTree, interfaceType);
      }
    }
  }

  private void checkSuperType(ClassTreeImpl tree, Type superType) {
    if (superType != null && superType.getSymbol().getName().equals(tree.getSymbol().getName())) {
      String classOrInterface = tree.is(Tree.Kind.CLASS) ? "class" : "interface";
      addIssue(tree, "Rename this " + classOrInterface + ".");
    }
  }

}