java/java-impl/src/com/intellij/psi/impl/source/javadoc/ParamDocTagInfo.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.psi.impl.source.javadoc;
  17
  18 import com.intellij.codeInsight.daemon.JavaErrorMessages;
  19 import com.intellij.lang.ASTNode;
  20 import com.intellij.pom.java.LanguageLevel;
  21 import com.intellij.psi.*;
  22 import com.intellij.psi.util.PsiUtil;
  23 import com.intellij.psi.javadoc.JavadocTagInfo;
  24 import com.intellij.psi.javadoc.PsiDocTagValue;
  25 import com.intellij.util.ArrayUtil;
  26
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.List;
  30
  31 /**
  32  * @author mike
  33  */
  34 class ParamDocTagInfo implements JavadocTagInfo {
  35   public String getName() {
  36     return "param";
  37   }
  38
  39   public boolean isValidInContext(PsiElement element) {
  40     return element instanceof PsiMethod ||
  41            (element instanceof PsiClass && PsiUtil.isLanguageLevel5OrHigher(element));
  42   }
  43
  44   public Object[] getPossibleValues(PsiElement context, PsiElement place, String prefix) {
  45     if (context instanceof PsiTypeParameterListOwner) {
  46       List<PsiNamedElement> result = new ArrayList<PsiNamedElement>(Arrays.asList(((PsiTypeParameterListOwner)context).getTypeParameters()));
  47
  48       if ((PsiTypeParameterListOwner)context instanceof PsiMethod) {
  49         PsiMethod method = (PsiMethod)context;
  50         result.addAll(Arrays.asList(method.getParameterList().getParameters()));
  51       }
  52
  53       return result.toArray(new PsiNamedElement[result.size()]);
  54     }
  55
  56     return ArrayUtil.EMPTY_OBJECT_ARRAY;
  57   }
  58
  59   public String checkTagValue(PsiDocTagValue value) {
  60     if (value == null) return JavaErrorMessages.message("javadoc.param.tag.paramter.name.expected");
  61     final ASTNode firstChildNode = value.getNode().getFirstChildNode();
  62     if (firstChildNode != null &&
  63         firstChildNode.getElementType().equals(JavaDocTokenType.DOC_TAG_VALUE_LT)) {
  64       if (value.getNode().findChildByType(JavaDocTokenType.DOC_TAG_VALUE_TOKEN) == null) {
  65         return JavaErrorMessages.message("javadoc.param.tag.type.parameter.name.expected");
  66       }
  67
  68       if (value.getNode().findChildByType(JavaDocTokenType.DOC_TAG_VALUE_GT) == null) {
  69         return JavaErrorMessages.message("javadoc.param.tag.type.parameter.gt.expected");
  70       }
  71     }
  72     return null;
  73   }
  74
  75   public PsiReference getReference(PsiDocTagValue value) {
  76     if (value instanceof PsiDocParamRef) return value.getReference();
  77     return null;
  78   }
  79
  80
  81   public boolean isInline() {
  82     return false;
  83   }
  84 }