Package com.intellij.codeInspection.reference

Class RefManager

java.lang.Object

com.intellij.codeInspection.reference.RefManager

Direct Known Subclasses:

RefManagerImpl

public abstract class RefManager
extends java.lang.Object

Manager of the reference graph for a global inspection run.

See Also:

GlobalInspectionContext.getRefManager()

Constructor Summary

Constructors

Constructor and Description
RefManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	belongsToScope(PsiElement psiElement)
Element	export(RefEntity entity, Element parent, int actualLine)
Element	export(RefEntity entity, int actualLine)
PsiNamedElement	getContainerElement(PsiElement element)
abstract <T> T	getExtension(Key<T> key)
abstract java.lang.String	getGroupName(RefElement entity)
abstract long	getLastUsedMask()
abstract Project	getProject() Returns the project for which the reference graph has been built.
abstract PsiManager	getPsiManager()
abstract java.lang.String	getQualifiedName(RefEntity refEntity)
abstract RefElement	getReference(PsiElement elem) Creates (if necessary) and returns the reference graph node for the specified PSI element.
abstract RefEntity	getReference(java.lang.String type, java.lang.String fqName) Creates (if necessary) and returns the reference graph node for the PSI element specified by its type and FQName.
abstract RefEntity	getRefinedElement(RefEntity ref)
abstract RefModule	getRefModule(Module module) Creates (if necessary) and returns the reference graph node for the specified module.
abstract RefProject	getRefProject() Returns the reference graph node pointing to the project for which the reference graph has been built.
abstract AnalysisScope	getScope() Returns the analysis scope for which the reference graph has been built.
abstract java.lang.String	getType(RefEntity ref)
boolean	isInGraph(VirtualFile file)
abstract void	iterate(RefVisitor visitor) Runs the specified visitor through all elements in the reference graph.
abstract void	removeRefElement(RefElement refElement, java.util.List<RefElement> deletedRefs)

Methods inherited from class java.lang.Object

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

Constructor Detail

RefManager

public RefManager()

Method Detail

iterate

public abstract void iterate(RefVisitor visitor)

Runs the specified visitor through all elements in the reference graph.

Parameters:

visitor - the visitor to run.

getScope

public abstract AnalysisScope getScope()

Returns the analysis scope for which the reference graph has been built.

Returns:

the analysis scope.

getProject

public abstract Project getProject()

Returns the project for which the reference graph has been built.

Returns:

the project instance.

getRefProject

public abstract RefProject getRefProject()

Returns the reference graph node pointing to the project for which the reference graph has been built.

Returns:

the node for the project.

getRefModule

public abstract RefModule getRefModule(Module module)

Creates (if necessary) and returns the reference graph node for the specified module.

Parameters:

module - the module for which the reference graph node is requested.

Returns:

the node for the module, or null if module is null.

getReference

public abstract RefElement getReference(PsiElement elem)

Creates (if necessary) and returns the reference graph node for the specified PSI element.

Parameters:

elem - the element for which the reference graph node is requested.

Returns:

the node for the element, or null if the element is not valid or does not have a corresponding reference graph node type (is not a field, method, class or file).

getReference

public abstract RefEntity getReference(java.lang.String type,
                                       java.lang.String fqName)

Creates (if necessary) and returns the reference graph node for the PSI element specified by its type and FQName.

Parameters:

type - SmartRefElementPointer#FILE, etc.

fqName - fully qualified name for the element

Returns:

the node for the element, or null if the element is not found or does not have a corresponding reference graph node type.

getLastUsedMask

public abstract long getLastUsedMask()

getExtension

public abstract <T> T getExtension(Key<T> key)

getType

public abstract java.lang.String getType(RefEntity ref)

getRefinedElement

public abstract RefEntity getRefinedElement(RefEntity ref)

export

public Element export(RefEntity entity,
                      Element parent,
                      int actualLine)

export

public Element export(RefEntity entity,
                      int actualLine)

getGroupName

public abstract java.lang.String getGroupName(RefElement entity)

belongsToScope

public abstract boolean belongsToScope(PsiElement psiElement)

getQualifiedName

public abstract java.lang.String getQualifiedName(RefEntity refEntity)

removeRefElement

public abstract void removeRefElement(RefElement refElement,
                                      java.util.List<RefElement> deletedRefs)

getPsiManager

public abstract PsiManager getPsiManager()

isInGraph

public boolean isInGraph(VirtualFile file)

Returns:

false if no RefManagerExtension was registered for language and is not covered by default implementation for PsiClassOwner true, otherwise

getContainerElement

public PsiNamedElement getContainerElement(PsiElement element)