plugins/InspectionGadgets/src/com/siyeh/ig/visibility/MethodOverridesPackageLocalMethodInspection.java

   1 /*
   2  * Copyright 2003-2007 Dave Griffith, Bas Leijdekkers
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.siyeh.ig.visibility;
  17
  18 import com.intellij.psi.*;
  19 import com.intellij.psi.util.PsiTreeUtil;
  20 import com.siyeh.InspectionGadgetsBundle;
  21 import com.siyeh.ig.BaseInspection;
  22 import com.siyeh.ig.BaseInspectionVisitor;
  23 import com.siyeh.ig.InspectionGadgetsFix;
  24 import com.siyeh.ig.fixes.RenameFix;
  25 import org.jetbrains.annotations.NotNull;
  26
  27 import java.util.HashSet;
  28 import java.util.Set;
  29
  30 public class MethodOverridesPackageLocalMethodInspection
  31         extends BaseInspection {
  32
  33     @NotNull
  34     public String getID() {
  35         return "MethodOverridesPrivateMethodOfSuperclass";
  36     }
  37
  38     @NotNull
  39     public String getDisplayName() {
  40         return InspectionGadgetsBundle.message(
  41                 "method.overrides.package.local.method.display.name");
  42     }
  43
  44     @NotNull
  45     public String buildErrorString(Object... infos) {
  46         return InspectionGadgetsBundle.message(
  47                 "method.overrides.package.local.method.problem.descriptor");
  48     }
  49
  50     protected InspectionGadgetsFix buildFix(Object... infos) {
  51         return new RenameFix();
  52     }
  53
  54     protected boolean buildQuickFixesOnlyForOnTheFlyErrors() {
  55         return true;
  56     }
  57
  58     public BaseInspectionVisitor buildVisitor() {
  59         return new MethodOverridesPrivateMethodVisitor();
  60     }
  61
  62     private static class MethodOverridesPrivateMethodVisitor
  63             extends BaseInspectionVisitor {
  64
  65         @Override public void visitMethod(@NotNull PsiMethod method) {
  66             final PsiClass aClass = method.getContainingClass();
  67             if (aClass == null) {
  68                 return;
  69             }
  70             if (method.getNameIdentifier() == null) {
  71                 return;
  72             }
  73             PsiClass ancestorClass = aClass.getSuperClass();
  74             final Set<PsiClass> visitedClasses = new HashSet<PsiClass>();
  75             while (ancestorClass != null) {
  76                 if (!visitedClasses.add(ancestorClass)) {
  77                     return;
  78                 }
  79                 final PsiMethod overridingMethod =
  80                         ancestorClass.findMethodBySignature(method, true);
  81                 if (overridingMethod != null) {
  82                     if (overridingMethod.hasModifierProperty(
  83                             PsiModifier.PACKAGE_LOCAL)) {
  84                         final PsiJavaFile file =
  85                                 PsiTreeUtil.getParentOfType(aClass,
  86                                                             PsiJavaFile.class);
  87                         if (file == null) {
  88                             return;
  89                         }
  90                         final PsiJavaFile ancestorFile =
  91                                 PsiTreeUtil.getParentOfType(ancestorClass,
  92                                                             PsiJavaFile.class);
  93                         if (ancestorFile == null) {
  94                             return;
  95                         }
  96                         final String packageName = file.getPackageName();
  97                         final String ancestorPackageName =
  98                                 ancestorFile.getPackageName();
  99                         if (!packageName.equals(ancestorPackageName)) {
 100                             registerMethodError(method);
 101                             return;
 102                         }
 103                     }
 104                 }
 105                 ancestorClass = ancestorClass.getSuperClass();
 106             }
 107         }
 108     }
 109 }