Package com.intellij.codeInsight

Class AnnotationTargetUtil

java.lang.Object

com.intellij.codeInsight.AnnotationTargetUtil

public class AnnotationTargetUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<PsiAnnotation.TargetType>	DEFAULT_TARGETS

Constructor Summary

Constructors

Constructor and Description
AnnotationTargetUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.Set<PsiAnnotation.TargetType>	extractRequiredAnnotationTargets(PsiAnnotationMemberValue value)
static PsiAnnotation.TargetType	findAnnotationTarget(PsiAnnotation annotation, PsiAnnotation.TargetType... types) From given targets, returns first where the annotation may be applied.
static PsiAnnotation.TargetType	findAnnotationTarget(PsiClass annotationType, PsiAnnotation.TargetType... types) From given targets, returns first where the annotation may be applied.
static java.util.Set<PsiAnnotation.TargetType>	getAnnotationTargets(PsiClass annotationType) Returns a set of targets where the given annotation may be applied, or null when the type is not a valid annotation.
static PsiAnnotationOwner	getTarget(PsiModifierListOwner modifierListOwner, java.lang.String annotation)
static PsiAnnotation.TargetType []	getTargetsForLocation(PsiAnnotationOwner owner)
static boolean	isTypeAnnotation(PsiAnnotation element) Returns true if the annotation resolves to a class having PsiAnnotation.TargetType.TYPE_USE in it's targets.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TARGETS

public static final java.util.Set<PsiAnnotation.TargetType> DEFAULT_TARGETS

Constructor Detail

AnnotationTargetUtil

public AnnotationTargetUtil()

Method Detail

getTargetsForLocation

public static PsiAnnotation.TargetType [] getTargetsForLocation(PsiAnnotationOwner owner)

extractRequiredAnnotationTargets

public static java.util.Set<PsiAnnotation.TargetType> extractRequiredAnnotationTargets(PsiAnnotationMemberValue value)

isTypeAnnotation

public static boolean isTypeAnnotation(PsiAnnotation element)

Returns true if the annotation resolves to a class having PsiAnnotation.TargetType.TYPE_USE in it's targets.

findAnnotationTarget

public static PsiAnnotation.TargetType findAnnotationTarget(PsiAnnotation annotation,
                                                            PsiAnnotation.TargetType... types)

From given targets, returns first where the annotation may be applied. Returns null when the annotation is not applicable at any of the targets, or PsiAnnotation.TargetType.UNKNOWN if the annotation does not resolve to a valid annotation type.

findAnnotationTarget

public static PsiAnnotation.TargetType findAnnotationTarget(PsiClass annotationType,
                                                            PsiAnnotation.TargetType... types)

From given targets, returns first where the annotation may be applied. Returns null when the annotation is not applicable at any of the targets, or PsiAnnotation.TargetType.UNKNOWN if the type is not a valid annotation (e.g. cannot be resolved).

getAnnotationTargets

public static java.util.Set<PsiAnnotation.TargetType> getAnnotationTargets(PsiClass annotationType)

Returns a set of targets where the given annotation may be applied, or null when the type is not a valid annotation.

getTarget

public static PsiAnnotationOwner getTarget(PsiModifierListOwner modifierListOwner,
                                           java.lang.String annotation)

Parameters:

modifierListOwner - modifier list owner

annotation - the qualified name of the annotation to add

Returns:

a target annotation owner to add the annotation (either modifier list or type element depending on the annotation target) Returns null if modifierListOwner.getModifierList() is null.