plugins/IntelliLang/java-support/org/intellij/plugins/intelliLang/util/AnnotateFix.java

/*
 * Copyright 2006 Sascha Weinreuter
 *
 * 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 org.intellij.plugins.intelliLang.util;

import com.intellij.codeInsight.FileModificationService;
import com.intellij.codeInspection.LocalQuickFix;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.navigation.NavigationItem;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.*;
import com.intellij.psi.codeStyle.JavaCodeStyleManager;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class AnnotateFix implements LocalQuickFix {
  private final PsiModifierListOwner myElement;
  private final String myAnnotationName;
  private final String myArgList;

  public AnnotateFix(@NotNull PsiModifierListOwner owner, String annotationClassname) {
    this(owner, annotationClassname, null);
  }

  public AnnotateFix(@NotNull PsiModifierListOwner owner, String annotationClassname, @Nullable String argList) {
    myElement = owner;
    myAnnotationName = annotationClassname;
    myArgList = argList;
  }

  @NotNull
  public String getName() {
    return "Annotate with @" + StringUtil.getShortName(myAnnotationName);
  }

  @NotNull
  public String getFamilyName() {
    return getName();
  }

  public boolean canApply() {
    return PsiUtilEx.isInSourceContent(myElement) && myElement.getModifierList() != null;
  }

  public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
    if (!FileModificationService.getInstance().preparePsiElementForWrite(myElement)) {
      return;
    }
    final PsiElementFactory factory = JavaPsiFacade.getInstance(project).getElementFactory();
    try {
      final PsiClass psiClass = JavaPsiFacade.getInstance(project).findClass(myAnnotationName, myElement.getResolveScope());
      final InitializerRequirement requirement = InitializerRequirement.calcInitializerRequirement(psiClass);

      final String argList;
      if (myArgList == null) {
        switch (requirement) {
          case VALUE_REQUIRED:
          case OTHER_REQUIRED:
            argList = "(\"\")";
            break;
          default:
            argList = "";
        }
      }
      else {
        argList = myArgList;
      }

      PsiAnnotation annotation = factory.createAnnotationFromText("@" + myAnnotationName + argList, myElement);
      final PsiModifierList modifierList = myElement.getModifierList();

      if (modifierList != null) {
        annotation = (PsiAnnotation)modifierList.addBefore(annotation, modifierList.getFirstChild());
        annotation = (PsiAnnotation)JavaCodeStyleManager.getInstance(project).shortenClassReferences(annotation);

        final PsiAnnotationParameterList list = annotation.getParameterList();
        if (requirement != InitializerRequirement.NONE_REQUIRED && myArgList == null) {
          ((NavigationItem)list).navigate(true);
        }
      }
    }
    catch (IncorrectOperationException e) {
      Logger.getInstance(getClass().getName()).error(e);
    }
  }
}