java/java-impl/src/com/intellij/codeInspection/concurrencyAnnotations/NonFinalGuardInspection.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 NonFinalGuardInspection 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 "Non-final @GuardedBy field";
  38   }
  39
  40   @NotNull
  41   public String getShortName() {
  42     return "NonFinalGuard";
  43   }
  44
  45
  46   @NotNull
  47   public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
  48     return new Visitor(holder);
  49   }
  50
  51   private static class Visitor extends JavaElementVisitor {
  52     private final ProblemsHolder myHolder;
  53
  54     public Visitor(ProblemsHolder holder) {
  55
  56       myHolder = holder;
  57     }
  58
  59     public void visitAnnotation(PsiAnnotation annotation) {
  60       super.visitAnnotation(annotation);
  61       if (!JCiPUtil.isGuardedByAnnotation(annotation)) {
  62         return;
  63       }
  64       final String guardValue = JCiPUtil.getGuardValue(annotation);
  65       if (guardValue == null || "this".equals(guardValue)) {
  66         return;
  67       }
  68       final PsiClass containingClass = PsiTreeUtil.getParentOfType(annotation, PsiClass.class);
  69       if (containingClass == null) {
  70         return;
  71       }
  72       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
  73       if (guardField == null) {
  74         return;
  75       }
  76       if (guardField.hasModifierProperty(PsiModifier.FINAL)) {
  77         return;
  78       }
  79       final PsiAnnotationMemberValue member = annotation.findAttributeValue("value");
  80       if (member == null) {
  81         return;
  82       }
  83       myHolder.registerProblem(member, "Non-final @GuardedBy field #ref #loc");
  84     }
  85
  86     public void visitDocTag(PsiDocTag psiDocTag) {
  87       super.visitDocTag(psiDocTag);
  88       if (!JCiPUtil.isGuardedByTag(psiDocTag)) {
  89         return;
  90       }
  91       final String guardValue = JCiPUtil.getGuardValue(psiDocTag);
  92       if ("this".equals(guardValue)) {
  93         return;
  94       }
  95       final PsiClass containingClass = PsiTreeUtil.getParentOfType(psiDocTag, PsiClass.class);
  96       if (containingClass == null) {
  97         return;
  98       }
  99       final PsiField guardField = containingClass.findFieldByName(guardValue, true);
 100       if (guardField == null) {
 101         return;
 102       }
 103       if (guardField.hasModifierProperty(PsiModifier.FINAL)) {
 104         return;
 105       }
 106       myHolder.registerProblem(psiDocTag, "Non-final @GuardedBy field \"" + guardValue + "\" #loc");
 107     }
 108
 109     public void visitReferenceExpression(PsiReferenceExpression expression) {
 110     }
 111   }
 112 }