java/java-impl/src/com/intellij/codeInspection/concurrencyAnnotations/InstanceGuardedByStaticInspection.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   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.intellij.codeInspection.concurrencyAnnotations;
  17
  18 import com.intellij.codeInsight.daemon.GroupNames;
  19 import com.intellij.codeInspection.BaseJavaLocalInspectionTool;
  20 import com.intellij.codeInspection.ProblemsHolder;
  21 import com.intellij.psi.*;
  22 import com.intellij.psi.javadoc.PsiDocTag;
  23 import com.intellij.psi.util.PsiTreeUtil;
  24 import org.jetbrains.annotations.Nls;
  25 import org.jetbrains.annotations.NotNull;
  26
  27 public class InstanceGuardedByStaticInspection extends BaseJavaLocalInspectionTool {
  28
  29   @NotNull
  30   public String getGroupDisplayName() {
  31     return GroupNames.CONCURRENCY_ANNOTATION_ISSUES;
  32   }
  33
  34   @Nls
  35   @NotNull
  36   public String getDisplayName() {
  37     return "Instance member guarded by static field";
  38   }
  39
  40   @NotNull
  41   public String getShortName() {
  42     return "InstanceGuardedByStatic";
  43   }
  44
  45   @NotNull
  46   public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
  47     return new Visitor(holder);
  48   }
  49
  50   private static class Visitor extends JavaElementVisitor {
  51     private final ProblemsHolder myHolder;
  52
  53     public Visitor(ProblemsHolder holder) {
  54       myHolder = holder;
  55     }
  56
  57
  58     public void visitDocTag(PsiDocTag psiDocTag) {
  59       super.visitDocTag(psiDocTag);
  60       if (!JCiPUtil.isGuardedByTag(psiDocTag)) {
  61         return;
  62       }
  63       final PsiMember member = PsiTreeUtil.getParentOfType(psiDocTag, PsiMember.class);
  64       if (member == null) {
  65         return;
  66       }
  67       if (member.hasModifierProperty(PsiModifier.STATIC)) {
  68         return;
  69       }
  70       final String guardValue = JCiPUtil.getGuardValue(psiDocTag);
  71
  72       final PsiClass containingClass = PsiTreeUtil.getParentOfType(psiDocTag, PsiClass.class);
  73       if (containingClass == null) {
  74         return;
  75       }
  76       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
  77       if (guardField == null) {
  78         return;
  79       }
  80       if (!guardField.hasModifierProperty(PsiModifier.STATIC)) {
  81         return;
  82       }
  83       myHolder.registerProblem(psiDocTag, "Instance member guarded by static \"" + guardValue + "\" #loc");
  84     }
  85
  86     public void visitReferenceExpression(PsiReferenceExpression expression) {
  87     }
  88
  89     public void visitAnnotation(PsiAnnotation annotation) {
  90       super.visitAnnotation(annotation);
  91       if (!JCiPUtil.isGuardedByAnnotation(annotation)) {
  92         return;
  93       }
  94       final PsiMember member = PsiTreeUtil.getParentOfType(annotation, PsiMember.class);
  95       if (member == null) {
  96         return;
  97       }
  98       if (member.hasModifierProperty(PsiModifier.STATIC)) {
  99         return;
 100       }
 101       final String guardValue = JCiPUtil.getGuardValue(annotation);
 102       if (guardValue == null) {
 103         return;
 104       }
 105
 106       final PsiAnnotationMemberValue guardRef = annotation.findAttributeValue("value");
 107       if (guardRef == null) {
 108         return;
 109       }
 110       final PsiClass containingClass = PsiTreeUtil.getParentOfType(annotation, PsiClass.class);
 111       if (containingClass == null) {
 112         return;
 113       }
 114       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
 115       if (guardField == null) {
 116         return;
 117       }
 118       if (!guardField.hasModifierProperty(PsiModifier.STATIC)) {
 119         return;
 120       }
 121       myHolder.registerProblem(guardRef, "Instance member guarded by static #ref #loc");
 122     }
 123   }
 124 }