| /* |
| * Copyright 2003-2013 Dave Griffith, Bas Leijdekkers |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package com.siyeh.ig.classlayout; |
| |
| import com.intellij.codeInspection.ProblemDescriptor; |
| import com.intellij.openapi.project.Project; |
| import com.intellij.psi.*; |
| import com.intellij.psi.javadoc.PsiDocComment; |
| import com.intellij.psi.javadoc.PsiDocTag; |
| import com.intellij.psi.util.PsiUtil; |
| import com.siyeh.InspectionGadgetsBundle; |
| import com.siyeh.ig.BaseInspection; |
| import com.siyeh.ig.BaseInspectionVisitor; |
| import com.siyeh.ig.InspectionGadgetsFix; |
| import org.jetbrains.annotations.NotNull; |
| |
| public class MissingDeprecatedAnnotationInspection extends BaseInspection { |
| |
| @Override |
| @NotNull |
| public String getDisplayName() { |
| return InspectionGadgetsBundle.message("missing.deprecated.annotation.display.name"); |
| } |
| |
| @Override |
| @NotNull |
| protected String buildErrorString(Object... infos) { |
| return InspectionGadgetsBundle.message("missing.deprecated.annotation.problem.descriptor"); |
| } |
| |
| @Override |
| public boolean runForWholeFile() { |
| return true; |
| } |
| |
| @Override |
| protected InspectionGadgetsFix buildFix(Object... infos) { |
| return new MissingDeprecatedAnnotationFix(); |
| } |
| |
| private static class MissingDeprecatedAnnotationFix extends InspectionGadgetsFix { |
| |
| @Override |
| @NotNull |
| public String getName() { |
| return InspectionGadgetsBundle.message("missing.deprecated.annotation.add.quickfix"); |
| } |
| |
| @NotNull |
| @Override |
| public String getFamilyName() { |
| return getName(); |
| } |
| |
| @Override |
| public void doFix(Project project, ProblemDescriptor descriptor) { |
| final PsiElement identifier = descriptor.getPsiElement(); |
| final PsiModifierListOwner parent = (PsiModifierListOwner)identifier.getParent(); |
| if (parent == null) { |
| return; |
| } |
| final PsiElementFactory factory = JavaPsiFacade.getElementFactory(project); |
| final PsiAnnotation annotation = factory.createAnnotationFromText("@java.lang.Deprecated", parent); |
| final PsiModifierList modifierList = parent.getModifierList(); |
| if (modifierList == null) { |
| return; |
| } |
| modifierList.addAfter(annotation, null); |
| } |
| } |
| |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new MissingDeprecatedAnnotationVisitor(); |
| } |
| |
| private static class MissingDeprecatedAnnotationVisitor extends BaseInspectionVisitor { |
| |
| @Override |
| public void visitClass(@NotNull PsiClass aClass) { |
| super.visitClass(aClass); |
| if (!PsiUtil.isLanguageLevel5OrHigher(aClass)) { |
| return; |
| } |
| if (!hasDeprecatedComment(aClass) || hasDeprecatedAnnotation(aClass)) { |
| return; |
| } |
| registerClassError(aClass); |
| } |
| |
| @Override |
| public void visitMethod(@NotNull PsiMethod method) { |
| if (!PsiUtil.isLanguageLevel5OrHigher(method)) { |
| return; |
| } |
| if (method.getNameIdentifier() == null) { |
| return; |
| } |
| if (!hasDeprecatedComment(method) || hasDeprecatedAnnotation(method)) { |
| return; |
| } |
| registerMethodError(method); |
| } |
| |
| @Override |
| public void visitField(@NotNull PsiField field) { |
| if (!PsiUtil.isLanguageLevel5OrHigher(field)) { |
| return; |
| } |
| if (!hasDeprecatedComment(field) || hasDeprecatedAnnotation(field)) { |
| return; |
| } |
| registerFieldError(field); |
| } |
| |
| private static boolean hasDeprecatedAnnotation(PsiModifierListOwner element) { |
| final PsiModifierList modifierList = element.getModifierList(); |
| if (modifierList == null) { |
| return false; |
| } |
| final PsiAnnotation annotation = modifierList.findAnnotation(CommonClassNames.JAVA_LANG_DEPRECATED); |
| return annotation != null; |
| } |
| |
| private static boolean hasDeprecatedComment(PsiDocCommentOwner element) { |
| final PsiDocComment comment = element.getDocComment(); |
| if (comment == null) { |
| return false; |
| } |
| final PsiDocTag deprecatedTag = comment.findTagByName("deprecated"); |
| return deprecatedTag != null; |
| } |
| } |
| } |