Package com.intellij.codeInsight

Class AnnotationUtil

java.lang.Object

com.intellij.codeInsight.AnnotationUtil

public class AnnotationUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECK_EXTERNAL
static int	CHECK_HIERARCHY
static int	CHECK_INFERRED
static int	CHECK_TYPE
static java.lang.String	LANGUAGE
static java.lang.String	NLS
static java.lang.String	NON_NLS
static java.lang.String	NOT_NULL
static java.lang.String	NULLABLE
static java.lang.String	PROPERTY_KEY
static java.lang.String	PROPERTY_KEY_RESOURCE_BUNDLE_PARAMETER
static java.lang.String	TEST_ONLY

Constructor Summary

Constructors

Constructor and Description
AnnotationUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<PsiAnnotationMemberValue>	arrayAttributeValues(PsiAnnotationMemberValue attributeValue)
static boolean	checkAnnotatedUsingPatterns(PsiModifierListOwner owner, java.util.Collection<java.lang.String> annotations) Works similar to #isAnnotated(PsiModifierListOwner, Collection) but supports FQN patters like "javax.ws.rs.*".
static boolean	equal(PsiAnnotation [] annotations1, PsiAnnotation [] annotations2) Ignores Override and SuppressWarnings annotations.
static boolean	equal(PsiAnnotationMemberValue value1, PsiAnnotationMemberValue value2)
static boolean	equal(PsiAnnotation a, PsiAnnotation b)
static java.util.List<PsiAnnotation>	findAllAnnotations(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotationNames, boolean skipExternal) Returns all annotations associated with listOwner having fully qualified names from annotationNames, including repeatable annotations and annotations from several external annotations roots.
static PsiAnnotation	findAnnotation(PsiModifierListOwner listOwner, boolean skipExternal, java.lang.String... annotationNames)
static PsiAnnotation	findAnnotation(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotationNames)
static PsiAnnotation	findAnnotation(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotationNames, boolean skipExternal)
static PsiAnnotation	findAnnotation(PsiModifierListOwner listOwner, java.util.Set<java.lang.String> annotationNames)
static PsiAnnotation	findAnnotation(PsiModifierListOwner listOwner, java.lang.String... annotationNames)
static <T extends java.lang.annotation.Annotation> T	findAnnotationInHierarchy(PsiModifierListOwner listOwner, java.lang.Class<T> annotationClass)
static PsiAnnotation	findAnnotationInHierarchy(PsiModifierListOwner listOwner, java.util.Set<java.lang.String> annotationNames)
static PsiAnnotation	findAnnotationInHierarchy(PsiModifierListOwner listOwner, java.util.Set<java.lang.String> annotationNames, boolean skipExternal)
static PsiAnnotation	findAnnotationInTypeHierarchy(PsiType type, java.util.Set<java.lang.String> qualifiedNames)
static PsiAnnotation []	findAnnotations(PsiModifierListOwner modifierListOwner, java.util.Collection<java.lang.String> annotationNames)
static PsiNameValuePair	findDeclaredAttribute(PsiAnnotation annotation, java.lang.String attributeName)
static PsiAnnotation []	getAllAnnotations(PsiModifierListOwner owner, boolean inHierarchy, java.util.Set<? super PsiModifierListOwner> visited)
static PsiAnnotation []	getAllAnnotations(PsiModifierListOwner owner, boolean inHierarchy, java.util.Set<? super PsiModifierListOwner> visited, boolean withInferred)
static PsiMethod	getAnnotationMethod(PsiNameValuePair pair)
static java.lang.Boolean	getBooleanAttributeValue(PsiAnnotation anno, java.lang.String attributeName)
static java.lang.String	getDeclaredStringAttributeValue(PsiAnnotation anno, java.lang.String attributeName)
static java.lang.Long	getLongAttributeValue(PsiAnnotation anno, java.lang.String attributeName)
static java.lang.String	getStringAttributeValue(PsiAnnotationMemberValue attrValue)
static java.lang.String	getStringAttributeValue(PsiAnnotation anno, java.lang.String attributeName)
static <T extends PsiModifierListOwner> java.util.List<T>	getSuperAnnotationOwners(T element)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotations) Deprecated. use isAnnotated(PsiModifierListOwner, Collection, int)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotations, boolean checkHierarchy) Deprecated. use isAnnotated(PsiModifierListOwner, Collection, int)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.util.Collection<java.lang.String> annotations, int flags)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.lang.String annotationFQN, boolean checkHierarchy) Deprecated. use isAnnotated(PsiModifierListOwner, String, int)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.lang.String annotationFQN, boolean checkHierarchy, boolean skipExternal) Deprecated. use isAnnotated(PsiModifierListOwner, String, int)
static boolean	isAnnotated(PsiModifierListOwner listOwner, java.lang.String annotationFqn, int flags)
static boolean	isAnnotatingApplicable(PsiElement elt)
static boolean	isAnnotatingApplicable(PsiElement elt, java.lang.String annotationFQN)
static boolean	isExternalAnnotation(PsiAnnotation annotation)
static boolean	isInferredAnnotation(PsiAnnotation annotation)
static boolean	isInsideAnnotation(PsiElement element)
static boolean	isJetbrainsAnnotation(java.lang.String simpleName) Deprecated. simple name is not enough for reliable identification

Methods inherited from class java.lang.Object

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

Field Detail

NULLABLE

public static final java.lang.String NULLABLE

See Also:

Constant Field Values

NOT_NULL

public static final java.lang.String NOT_NULL

See Also:

Constant Field Values

NON_NLS

public static final java.lang.String NON_NLS

See Also:

Constant Field Values

NLS

public static final java.lang.String NLS

See Also:

Constant Field Values

PROPERTY_KEY

public static final java.lang.String PROPERTY_KEY

See Also:

Constant Field Values

PROPERTY_KEY_RESOURCE_BUNDLE_PARAMETER

public static final java.lang.String PROPERTY_KEY_RESOURCE_BUNDLE_PARAMETER

See Also:

Constant Field Values

TEST_ONLY

public static final java.lang.String TEST_ONLY

See Also:

Constant Field Values

LANGUAGE

public static final java.lang.String LANGUAGE

See Also:

Constant Field Values

CHECK_HIERARCHY

public static final int CHECK_HIERARCHY

See Also:

Constant Field Values

CHECK_EXTERNAL

public static final int CHECK_EXTERNAL

See Also:

Constant Field Values

CHECK_INFERRED

public static final int CHECK_INFERRED

See Also:

Constant Field Values

CHECK_TYPE

public static final int CHECK_TYPE

See Also:

Constant Field Values

Constructor Detail

AnnotationUtil

public AnnotationUtil()

Method Detail

findAnnotation

public static PsiAnnotation findAnnotation(PsiModifierListOwner listOwner,
                                           java.lang.String... annotationNames)

findAnnotation

public static PsiAnnotation findAnnotation(PsiModifierListOwner listOwner,
                                           boolean skipExternal,
                                           java.lang.String... annotationNames)

findAnnotation

public static PsiAnnotation findAnnotation(PsiModifierListOwner listOwner,
                                           java.util.Set<java.lang.String> annotationNames)

findAnnotation

public static PsiAnnotation findAnnotation(PsiModifierListOwner listOwner,
                                           java.util.Collection<java.lang.String> annotationNames)

findAnnotation

public static PsiAnnotation findAnnotation(PsiModifierListOwner listOwner,
                                           java.util.Collection<java.lang.String> annotationNames,
                                           boolean skipExternal)

findAllAnnotations

public static java.util.List<PsiAnnotation> findAllAnnotations(PsiModifierListOwner listOwner,
                                                               java.util.Collection<java.lang.String> annotationNames,
                                                               boolean skipExternal)

Returns all annotations associated with listOwner having fully qualified names from annotationNames, including repeatable annotations and annotations from several external annotations roots.

Parameters:

listOwner - element to search annotations of

annotationNames - fully-qualified annotations names to search for

skipExternal - false if external and inferred annotations must also be searched, true only to search for own annotations declared in source code

Returns:

all annotations of listOwner, including repeatable annotation and annotations from several source roots, having FQ names from annotationNames.

findAnnotations

public static PsiAnnotation [] findAnnotations(PsiModifierListOwner modifierListOwner,
                                               java.util.Collection<java.lang.String> annotationNames)

getSuperAnnotationOwners

public static <T extends PsiModifierListOwner> java.util.List<T> getSuperAnnotationOwners(T element)

findAnnotationInHierarchy

public static PsiAnnotation findAnnotationInHierarchy(PsiModifierListOwner listOwner,
                                                      java.util.Set<java.lang.String> annotationNames)

findAnnotationInHierarchy

public static PsiAnnotation findAnnotationInHierarchy(PsiModifierListOwner listOwner,
                                                      java.util.Set<java.lang.String> annotationNames,
                                                      boolean skipExternal)

findAnnotationInTypeHierarchy

public static PsiAnnotation findAnnotationInTypeHierarchy(PsiType type,
                                                          java.util.Set<java.lang.String> qualifiedNames)

Parameters:

type - type to check

qualifiedNames - annotation qualified names of TYPE_USE annotations to look for

Returns:

found type annotation, or null if not found. For type parameter types upper bound annotations are also checked

isAnnotated

public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.util.Collection<java.lang.String> annotations,
                                  int flags)

isAnnotated

public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.lang.String annotationFqn,
                                  int flags)

isAnnotatingApplicable

public static boolean isAnnotatingApplicable(PsiElement elt)

isAnnotatingApplicable

public static boolean isAnnotatingApplicable(PsiElement elt,
                                             java.lang.String annotationFQN)

checkAnnotatedUsingPatterns

public static boolean checkAnnotatedUsingPatterns(PsiModifierListOwner owner,
                                                  java.util.Collection<java.lang.String> annotations)

Works similar to #isAnnotated(PsiModifierListOwner, Collection) but supports FQN patters like "javax.ws.rs.*". Supports ending "*" only.

Parameters:

owner - modifier list

annotations - annotations qualified names or patterns. Patterns can have '*' at the end

Returns:

true if annotated of at least one annotation from the annotations list

getAnnotationMethod

public static PsiMethod getAnnotationMethod(PsiNameValuePair pair)

getAllAnnotations

public static PsiAnnotation [] getAllAnnotations(PsiModifierListOwner owner,
                                                 boolean inHierarchy,
                                                 java.util.Set<? super PsiModifierListOwner> visited)

getAllAnnotations

public static PsiAnnotation [] getAllAnnotations(PsiModifierListOwner owner,
                                                 boolean inHierarchy,
                                                 java.util.Set<? super PsiModifierListOwner> visited,
                                                 boolean withInferred)

isInsideAnnotation

public static boolean isInsideAnnotation(PsiElement element)

isInferredAnnotation

public static boolean isInferredAnnotation(PsiAnnotation annotation)

isExternalAnnotation

public static boolean isExternalAnnotation(PsiAnnotation annotation)

getStringAttributeValue

public static java.lang.String getStringAttributeValue(PsiAnnotation anno,
                                                       java.lang.String attributeName)

getBooleanAttributeValue

public static java.lang.Boolean getBooleanAttributeValue(PsiAnnotation anno,
                                                         java.lang.String attributeName)

getLongAttributeValue

public static java.lang.Long getLongAttributeValue(PsiAnnotation anno,
                                                   java.lang.String attributeName)

getDeclaredStringAttributeValue

public static java.lang.String getDeclaredStringAttributeValue(PsiAnnotation anno,
                                                               java.lang.String attributeName)

getStringAttributeValue

public static java.lang.String getStringAttributeValue(PsiAnnotationMemberValue attrValue)

findAnnotationInHierarchy

public static <T extends java.lang.annotation.Annotation> T findAnnotationInHierarchy(PsiModifierListOwner listOwner,
                                                                                      java.lang.Class<T> annotationClass)

findDeclaredAttribute

public static PsiNameValuePair findDeclaredAttribute(PsiAnnotation annotation,
                                                     java.lang.String attributeName)

equal

public static boolean equal(PsiAnnotation a,
                            PsiAnnotation b)

equal

public static boolean equal(PsiAnnotationMemberValue value1,
                            PsiAnnotationMemberValue value2)

equal

public static boolean equal(PsiAnnotation [] annotations1,
                            PsiAnnotation [] annotations2)

Ignores Override and SuppressWarnings annotations.

isJetbrainsAnnotation

@Deprecated
public static boolean isJetbrainsAnnotation(java.lang.String simpleName)

Deprecated. simple name is not enough for reliable identification

isAnnotated

@Deprecated
public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.util.Collection<java.lang.String> annotations)

Deprecated. use isAnnotated(PsiModifierListOwner, Collection, int)

isAnnotated

@Deprecated
public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.util.Collection<java.lang.String> annotations,
                                  boolean checkHierarchy)

Deprecated. use isAnnotated(PsiModifierListOwner, Collection, int)

isAnnotated

@Deprecated
public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.lang.String annotationFQN,
                                  boolean checkHierarchy)

Deprecated. use isAnnotated(PsiModifierListOwner, String, int)

isAnnotated

@Deprecated
public static boolean isAnnotated(PsiModifierListOwner listOwner,
                                  java.lang.String annotationFQN,
                                  boolean checkHierarchy,
                                  boolean skipExternal)

Deprecated. use isAnnotated(PsiModifierListOwner, String, int)

arrayAttributeValues

public static java.util.List<PsiAnnotationMemberValue> arrayAttributeValues(PsiAnnotationMemberValue attributeValue)