Package com.intellij.codeInsight

Class BaseExternalAnnotationsManager

java.lang.Object

com.intellij.codeInsight.ExternalAnnotationsManager

com.intellij.codeInsight.BaseExternalAnnotationsManager

Direct Known Subclasses:

ReadableExternalAnnotationsManager

public abstract class BaseExternalAnnotationsManager
extends ExternalAnnotationsManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseExternalAnnotationsManager.AnnotationData

Nested classes/interfaces inherited from class com.intellij.codeInsight.ExternalAnnotationsManager

ExternalAnnotationsManager.AnnotationPlace, ExternalAnnotationsManager.CanceledConfigurationException

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiManager	myPsiManager

Fields inherited from class com.intellij.codeInsight.ExternalAnnotationsManager

ANNOTATIONS_XML, TOPIC

Constructor Summary

Constructors

Constructor and Description
BaseExternalAnnotationsManager(PsiManager psiManager)

Method Summary

Modifier and Type	Method and Description
void	annotateExternally(PsiModifierListOwner listOwner, java.lang.String annotationFQName, PsiFile fromFile, PsiNameValuePair [] value)
ExternalAnnotationsManager.AnnotationPlace	chooseAnnotationsPlace(PsiElement element)
ExternalAnnotationsManager.AnnotationPlace	chooseAnnotationsPlaceNoUi(PsiElement element)
boolean	deannotate(PsiModifierListOwner listOwner, java.lang.String annotationFQN)
protected void	dropCache()
protected void	duplicateError(PsiFile file, java.lang.String externalName, java.lang.String text)
boolean	editExternalAnnotation(PsiModifierListOwner listOwner, java.lang.String annotationFQN, PsiNameValuePair [] value)
java.util.List<PsiAnnotation>	findDefaultConstructorExternalAnnotations(PsiClass aClass) Returns external annotations associated with default constructor of the aClass, if the constructor exists.
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.
PsiAnnotation	findExternalAnnotation(PsiModifierListOwner listOwner, java.lang.String annotationFQN)
PsiAnnotation []	findExternalAnnotations(PsiModifierListOwner listOwner)
java.util.List<PsiAnnotation>	findExternalAnnotations(PsiModifierListOwner listOwner, java.lang.String annotationFQN) Returns external annotations with fully qualified name of annotationFQN associated with listOwner.
java.util.List<PsiFile>	findExternalAnnotationsFiles(PsiModifierListOwner listOwner)
MostlySingularMultiMap<java.lang.String,BaseExternalAnnotationsManager.AnnotationData>	getDataFromFile(PsiFile file)
protected abstract java.util.List<VirtualFile>	getExternalAnnotationsRoots(VirtualFile libraryFile)
protected static java.lang.String	getExternalName(PsiModifierListOwner listOwner) Returns canonical string presentation of listOwner used in external annotations files.
boolean	hasAnnotationRootsForFile(VirtualFile file)
protected abstract boolean	hasAnyAnnotationsRoots()
boolean	isExternalAnnotation(PsiAnnotation annotation)
boolean	isExternalAnnotationWritable(PsiModifierListOwner listOwner, java.lang.String annotationFQN)
protected void	registerExternalAnnotations(java.lang.Object key, PsiFile annotationsFile)

Methods inherited from class com.intellij.codeInsight.ExternalAnnotationsManager

elementRenamedOrMoved, getInstance

Methods inherited from class java.lang.Object

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

Field Detail

myPsiManager

protected final PsiManager myPsiManager

Constructor Detail

BaseExternalAnnotationsManager

public BaseExternalAnnotationsManager(PsiManager psiManager)

Method Detail

getExternalName

protected static java.lang.String getExternalName(PsiModifierListOwner listOwner)

Returns canonical string presentation of listOwner used in external annotations files.

Parameters:

listOwner - API element to return external name of

Returns:

external name or null if the listOwner is of unknown type (neither class, method, field nor parameter)

hasAnyAnnotationsRoots

protected abstract boolean hasAnyAnnotationsRoots()

hasAnnotationRootsForFile

public boolean hasAnnotationRootsForFile(VirtualFile file)

Specified by:

hasAnnotationRootsForFile in class ExternalAnnotationsManager

isExternalAnnotation

public boolean isExternalAnnotation(PsiAnnotation annotation)

Specified by:

isExternalAnnotation in class ExternalAnnotationsManager

findExternalAnnotation

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

Specified by:

findExternalAnnotation in class ExternalAnnotationsManager

findExternalAnnotations

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

Description copied from class: ExternalAnnotationsManager

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.

Specified by:

findExternalAnnotations in class ExternalAnnotationsManager

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

findDefaultConstructorExternalAnnotations

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

Description copied from class: ExternalAnnotationsManager

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.

Specified by:

findDefaultConstructorExternalAnnotations in class ExternalAnnotationsManager

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:

ExternalAnnotationsManager.findDefaultConstructorExternalAnnotations(PsiClass)

findDefaultConstructorExternalAnnotations

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

Description copied from class: ExternalAnnotationsManager

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>

Specified by:

findDefaultConstructorExternalAnnotations in class ExternalAnnotationsManager

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

isExternalAnnotationWritable

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

Specified by:

isExternalAnnotationWritable in class ExternalAnnotationsManager

findExternalAnnotations

public PsiAnnotation [] findExternalAnnotations(PsiModifierListOwner listOwner)

Specified by:

findExternalAnnotations in class ExternalAnnotationsManager

getDataFromFile

public MostlySingularMultiMap<java.lang.String,BaseExternalAnnotationsManager.AnnotationData> getDataFromFile(PsiFile file)

duplicateError

protected void duplicateError(PsiFile file,
                              java.lang.String externalName,
                              java.lang.String text)

findExternalAnnotationsFiles

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

Specified by:

findExternalAnnotationsFiles in class ExternalAnnotationsManager

getExternalAnnotationsRoots

protected abstract java.util.List<VirtualFile> getExternalAnnotationsRoots(VirtualFile libraryFile)

dropCache

protected void dropCache()

annotateExternally

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

Specified by:

annotateExternally in class ExternalAnnotationsManager

Throws:

ExternalAnnotationsManager.CanceledConfigurationException

deannotate

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

Specified by:

deannotate in class ExternalAnnotationsManager

editExternalAnnotation

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

Specified by:

editExternalAnnotation in class ExternalAnnotationsManager

chooseAnnotationsPlaceNoUi

public ExternalAnnotationsManager.AnnotationPlace chooseAnnotationsPlaceNoUi(PsiElement element)

Specified by:

chooseAnnotationsPlaceNoUi in class ExternalAnnotationsManager

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 ExternalAnnotationsManager.AnnotationPlace chooseAnnotationsPlace(PsiElement element)

Specified by:

chooseAnnotationsPlace in class ExternalAnnotationsManager

Parameters:

element - element to add new annotation for

Returns:

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

registerExternalAnnotations

protected void registerExternalAnnotations(java.lang.Object key,
                                           PsiFile annotationsFile)