/*
 * Copyright 2015 The authors
 * 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.intellij.struts2.annotators;

import com.intellij.openapi.fileTypes.StdFileTypes;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiElement;
import icons.Struts2Icons;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;

/**
 * Annotator for JAVA-Action-classes.
 * Provides gutter icon navigation to <action> declaration(s).
 *
 * @author Yann Cébron
 */
public class ActionJavaAnnotator extends ActionAnnotatorBase {

  @Override
  public String getId() {
    return "ActionJavaAnnotator";
  }

  @Override
  public String getName() {
    return "Action (Java)";
  }

  @Nullable
  @Override
  public Icon getIcon() {
    return Struts2Icons.Action;
  }

  protected PsiClass getActionPsiClass(@NotNull final PsiElement psiElement) {
    if (!(psiElement instanceof PsiClass)) {
      return null;
    }

    // do not run on classes within JSPs
    if (psiElement.getContainingFile().getFileType() != StdFileTypes.JAVA) {
      return null;
    }

    return (PsiClass)psiElement;
  }
}