Package com.intellij.codeInsight

Class ExternalAnnotationsManager

java.lang.Object

com.intellij.codeInsight.ExternalAnnotationsManager

Direct Known Subclasses:

BaseExternalAnnotationsManager

public abstract class ExternalAnnotationsManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalAnnotationsManager.AnnotationPlace Describes where to place the new annotation
static class	ExternalAnnotationsManager.CanceledConfigurationException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATIONS_XML
static Topic<ExternalAnnotationsListener>	TOPIC

Constructor Summary

Constructors

Constructor and Description
ExternalAnnotationsManager()

Method Summary

Modifier and Type	Method and Description
abstract void	annotateExternally(PsiModifierListOwner listOwner, java.lang.String annotationFQName, PsiFile fromFile, PsiNameValuePair [] value)
abstract ExternalAnnotationsManager.AnnotationPlace	chooseAnnotationsPlace(PsiElement element)
abstract ExternalAnnotationsManager.AnnotationPlace	chooseAnnotationsPlaceNoUi(PsiElement element)
abstract boolean	deannotate(PsiModifierListOwner listOwner, java.lang.String annotationFQN)
abstract boolean	editExternalAnnotation(PsiModifierListOwner listOwner, java.lang.String annotationFQN, PsiNameValuePair [] value)
void	elementRenamedOrMoved(PsiModifierListOwner element, java.lang.String oldExternalName)
abstract java.util.List<PsiAnnotation>	findDefaultConstructorExternalAnnotations(PsiClass aClass) Returns external annotations associated with default constructor of the aClass, if the constructor exists.
abstract java.util.List<PsiAnnotation>	findDefaultConstructorExternalAnnotations(PsiClass aClass, java.lang.String annotationFQN) Returns external annotations with fully qualified name of annotationFQN associated with default constructor of the aClass, if the constructor exists.
abstract PsiAnnotation	findExternalAnnotation(PsiModifierListOwner listOwner, java.lang.String annotationFQN)
abstract PsiAnnotation []	findExternalAnnotations(PsiModifierListOwner listOwner)
abstract java.util.List<PsiAnnotation>	findExternalAnnotations(PsiModifierListOwner listOwner, java.lang.String annotationFQN) Returns external annotations with fully qualified name of annotationFQN associated with listOwner.
abstract java.util.List<PsiFile>	findExternalAnnotationsFiles(PsiModifierListOwner listOwner)
static ExternalAnnotationsManager	getInstance(Project project)
abstract boolean	hasAnnotationRootsForFile(VirtualFile file)
abstract boolean	isExternalAnnotation(PsiAnnotation annotation)
abstract boolean	isExternalAnnotationWritable(PsiModifierListOwner listOwner, java.lang.String annotationFQN)

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATIONS_XML

public static final java.lang.String ANNOTATIONS_XML

See Also:

Constant Field Values

TOPIC

public static final Topic<ExternalAnnotationsListener> TOPIC

Constructor Detail

ExternalAnnotationsManager

public ExternalAnnotationsManager()

Method Detail

getInstance

public static ExternalAnnotationsManager getInstance(Project project)

hasAnnotationRootsForFile

public abstract boolean hasAnnotationRootsForFile(VirtualFile file)

isExternalAnnotation

public abstract boolean isExternalAnnotation(PsiAnnotation annotation)

findExternalAnnotation

public abstract PsiAnnotation findExternalAnnotation(PsiModifierListOwner listOwner,
                                                     java.lang.String annotationFQN)

findExternalAnnotations

public abstract java.util.List<PsiAnnotation> findExternalAnnotations(PsiModifierListOwner listOwner,
                                                                      java.lang.String annotationFQN)

Returns external annotations with fully qualified name of annotationFQN associated with listOwner. Multiple results may be returned for repeatable annotations and annotations from several external annotations roots.

Parameters:

listOwner - API element to return external annotations of

annotationFQN - fully qualified name of the annotation to search for

Returns:

external annotations of the listOwner

isExternalAnnotationWritable

public abstract boolean isExternalAnnotationWritable(PsiModifierListOwner listOwner,
                                                     java.lang.String annotationFQN)

findExternalAnnotations

public abstract PsiAnnotation [] findExternalAnnotations(PsiModifierListOwner listOwner)

findDefaultConstructorExternalAnnotations

public abstract java.util.List<PsiAnnotation> findDefaultConstructorExternalAnnotations(PsiClass aClass)

Returns external annotations associated with default constructor of the aClass, if the constructor exists.

Default constructors should be handled specially because they don't have PsiModifierListOwner, nor they are returned in PsiClass.getConstructors().

Yet default constructors may be externally annotated in corresponding annotations.xml:

 <item name='com.example.Foo Foo()'>
  <annotation name='org.some.Annotation'/>
 </item>

Parameters:

aClass - class of which default constructor's external annotations are to be found

Returns:

external annotations of the default constructor of aClass or null if the class doesn't have a default constructor

findDefaultConstructorExternalAnnotations

public abstract java.util.List<PsiAnnotation> findDefaultConstructorExternalAnnotations(PsiClass aClass,
                                                                                        java.lang.String annotationFQN)

Returns external annotations with fully qualified name of annotationFQN associated with default constructor of the aClass, if the constructor exists. Multiple annotations may be returned since there may be repeatable annotations or annotations from several external annotations roots.

Parameters:

aClass - class of which default constructor's external annotations are to be found

annotationFQN - fully qualified name of annotation class to search for

Returns:

annotations of the default constructor of aClass, or null if the class doesn't have a default constructor.

See Also:

findDefaultConstructorExternalAnnotations(PsiClass)

annotateExternally

public abstract void annotateExternally(PsiModifierListOwner listOwner,
                                        java.lang.String annotationFQName,
                                        PsiFile fromFile,
                                        PsiNameValuePair [] value)
                                 throws ExternalAnnotationsManager.CanceledConfigurationException

Throws:

ExternalAnnotationsManager.CanceledConfigurationException

deannotate

public abstract boolean deannotate(PsiModifierListOwner listOwner,
                                   java.lang.String annotationFQN)

elementRenamedOrMoved

public void elementRenamedOrMoved(PsiModifierListOwner element,
                                  java.lang.String oldExternalName)

editExternalAnnotation

public abstract boolean editExternalAnnotation(PsiModifierListOwner listOwner,
                                               java.lang.String annotationFQN,
                                               PsiNameValuePair [] value)

chooseAnnotationsPlaceNoUi

public abstract ExternalAnnotationsManager.AnnotationPlace chooseAnnotationsPlaceNoUi(PsiElement element)

Parameters:

element - element to add new annotation for

Returns:

place where the annotation must be added. No UI is displayed, so can be called inside any read-action. May return ExternalAnnotationsManager.AnnotationPlace.NEED_ASK_USER if the user confirmation is necessary.

chooseAnnotationsPlace

public abstract ExternalAnnotationsManager.AnnotationPlace chooseAnnotationsPlace(PsiElement element)

Parameters:

element - element to add new annotation for

Returns:

place where the annotation must be added. Must be called in EDT.

findExternalAnnotationsFiles

public abstract java.util.List<PsiFile> findExternalAnnotationsFiles(PsiModifierListOwner listOwner)