plugins/InspectionGadgets/src/com/siyeh/ig/finalization/FinalizeCallsSuperFinalizeInspection.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.finalization;
  17
  18 import com.intellij.psi.PsiClass;
  19 import com.intellij.psi.PsiMethod;
  20 import com.intellij.psi.PsiModifier;
  21 import com.intellij.psi.PsiParameterList;
  22 import com.siyeh.HardcodedMethodConstants;
  23 import com.siyeh.InspectionGadgetsBundle;
  24 import com.siyeh.ig.BaseInspection;
  25 import com.siyeh.ig.BaseInspectionVisitor;
  26 import com.siyeh.ig.ui.SingleCheckboxOptionsPanel;
  27 import org.jetbrains.annotations.NotNull;
  28
  29 import javax.swing.*;
  30
  31 public class FinalizeCallsSuperFinalizeInspection extends BaseInspection {
  32
  33     @SuppressWarnings("PublicField")
  34     public boolean m_ignoreForObjectSubclasses = false;
  35
  36     @NotNull
  37     public String getID(){
  38         return "FinalizeDoesntCallSuperFinalize";
  39     }
  40
  41     @NotNull
  42     public String getDisplayName(){
  43         return InspectionGadgetsBundle.message(
  44                 "finalize.doesnt.call.super.display.name");
  45     }
  46
  47     @NotNull
  48     public String buildErrorString(Object... infos){
  49         return InspectionGadgetsBundle.message(
  50                 "finalize.doesnt.call.super.problem.descriptor");
  51     }
  52
  53     public boolean isEnabledByDefault(){
  54         return true;
  55     }
  56
  57     public JComponent createOptionsPanel(){
  58         return new SingleCheckboxOptionsPanel(InspectionGadgetsBundle.message(
  59                 "finalize.doesnt.call.super.ignore.option"),
  60                 this, "m_ignoreForObjectSubclasses");
  61     }
  62
  63     public BaseInspectionVisitor buildVisitor(){
  64         return new NoExplicitFinalizeCallsVisitor();
  65     }
  66
  67     private class NoExplicitFinalizeCallsVisitor extends BaseInspectionVisitor{
  68
  69         @Override public void visitMethod(@NotNull PsiMethod method){
  70             //note: no call to super;
  71             final String methodName = method.getName();
  72             if(!HardcodedMethodConstants.FINALIZE.equals(methodName)){
  73                 return;
  74             }
  75             if(method.hasModifierProperty(PsiModifier.NATIVE) ||
  76                     method.hasModifierProperty(PsiModifier.ABSTRACT)){
  77                 return;
  78             }
  79             final PsiClass containingClass = method.getContainingClass();
  80             if(containingClass == null){
  81                 return;
  82             }
  83             if(m_ignoreForObjectSubclasses){
  84                 final PsiClass superClass = containingClass.getSuperClass();
  85                 if(superClass != null){
  86                     final String superClassName = superClass.getQualifiedName();
  87                     if("java.lang.Object".equals(superClassName)){
  88                         return;
  89                     }
  90                 }
  91             }
  92             final PsiParameterList parameterList = method.getParameterList();
  93             if(parameterList.getParametersCount() != 0){
  94                 return;
  95             }
  96             final CallToSuperFinalizeVisitor visitor =
  97                     new CallToSuperFinalizeVisitor();
  98             method.accept(visitor);
  99             if(visitor.isCallToSuperFinalizeFound()){
 100                 return;
 101             }
 102             registerMethodError(method);
 103         }
 104     }
 105 }