plugins/InspectionGadgets/src/com/siyeh/ig/naming/NonExceptionNameEndsWithExceptionInspection.java

   1 /*
   2  * Copyright 2003-2008 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.naming;
  17
  18 import com.intellij.codeInspection.ProblemDescriptor;
  19 import com.intellij.openapi.project.Project;
  20 import com.intellij.psi.*;
  21 import com.intellij.psi.search.GlobalSearchScope;
  22 import com.intellij.util.IncorrectOperationException;
  23 import com.siyeh.InspectionGadgetsBundle;
  24 import com.siyeh.ig.BaseInspection;
  25 import com.siyeh.ig.BaseInspectionVisitor;
  26 import com.siyeh.ig.InspectionGadgetsFix;
  27 import com.siyeh.ig.fixes.RenameFix;
  28 import com.siyeh.ig.psiutils.ClassUtils;
  29 import org.jetbrains.annotations.NonNls;
  30 import org.jetbrains.annotations.NotNull;
  31
  32 public class NonExceptionNameEndsWithExceptionInspection
  33         extends BaseInspection {
  34
  35     @Override @NotNull
  36     public String getDisplayName() {
  37         return InspectionGadgetsBundle.message(
  38                 "non.exception.name.ends.with.exception.display.name");
  39     }
  40
  41     @Override @NotNull
  42     protected String buildErrorString(Object... infos) {
  43         return InspectionGadgetsBundle.message(
  44                 "non.exception.name.ends.with.exception.problem.descriptor");
  45     }
  46
  47     @Override @NotNull
  48     protected InspectionGadgetsFix[] buildFixes(Object... infos) {
  49         final String name = (String) infos[0];
  50         return new InspectionGadgetsFix[] {new RenameFix(),
  51                 new ExtendExceptionFix(name)};
  52     }
  53
  54     private static class ExtendExceptionFix extends InspectionGadgetsFix {
  55
  56         private final String name;
  57
  58         public ExtendExceptionFix(String name) {
  59             this.name = name;
  60         }
  61
  62         @NotNull
  63         public String getName() {
  64             return InspectionGadgetsBundle.message(
  65                     "non.exception.name.ends.with.exception.quickfix", name);
  66         }
  67
  68         @Override
  69         protected void doFix(Project project, ProblemDescriptor descriptor)
  70                 throws IncorrectOperationException {
  71             final PsiElement element = descriptor.getPsiElement();
  72             final PsiElement parent = element.getParent();
  73             if (!(parent instanceof PsiClass)) {
  74                 return;
  75             }
  76             final PsiClass aClass = (PsiClass) parent;
  77             final PsiReferenceList extendsList = aClass.getExtendsList();
  78             if (extendsList == null) {
  79                 return;
  80             }
  81             final JavaPsiFacade facade = JavaPsiFacade.getInstance(project);
  82             final PsiElementFactory factory = facade.getElementFactory();
  83             final GlobalSearchScope scope = aClass.getResolveScope();
  84             final PsiJavaCodeReferenceElement reference =
  85                     factory.createReferenceElementByFQClassName(
  86                             "java.lang.Exception", scope);
  87             extendsList.add(reference);
  88         }
  89     }
  90
  91     @Override
  92     protected boolean buildQuickFixesOnlyForOnTheFlyErrors() {
  93         return true;
  94     }
  95
  96     @Override
  97     public BaseInspectionVisitor buildVisitor() {
  98         return new NonExceptionNameEndsWithExceptionVisitor();
  99     }
 100
 101     private static class NonExceptionNameEndsWithExceptionVisitor
 102             extends BaseInspectionVisitor {
 103
 104         @Override public void visitClass(@NotNull PsiClass aClass) {
 105             // no call to super, so it doesn't drill down into inner classes
 106             final String className = aClass.getName();
 107             if (className == null) {
 108                 return;
 109             }
 110             @NonNls final String exception = "Exception";
 111             if (!className.endsWith(exception)) {
 112                 return;
 113             }
 114             if (ClassUtils.isSubclass(aClass, "java.lang.Exception")) {
 115                 return;
 116             }
 117             registerClassError(aClass, className);
 118         }
 119     }
 120 }