Package com.intellij.codeInspection.reference

Interface RefElement

All Superinterfaces:

RefEntity, UserDataHolder

All Known Subinterfaces:

RefClass, RefDirectory, RefField, RefFile, RefImplicitConstructor, RefJavaElement, RefJavaModule, RefMethod, RefParameter, WritableRefElement

All Known Implementing Classes:

RefClassImpl, RefDirectoryImpl, RefElementImpl, RefFieldImpl, RefFileImpl, RefImplicitConstructorImpl, RefJavaElementImpl, RefJavaFileImpl, RefJavaModuleImpl, RefMethodImpl, RefParameterImpl

public interface RefElement
extends RefEntity

A node in the reference graph corresponding to a PSI element.

Field Summary

Fields inherited from interface com.intellij.codeInspection.reference.RefEntity

EMPTY_ELEMENTS_ARRAY

Method Summary

Modifier and Type	Method and Description
RefElement	getContainingEntry()
default PsiElement	getElement() Deprecated. use getPsiElement()
java.util.Collection<RefElement>	getInReferences() Returns the collection of references from other elements to this element.
RefModule	getModule() Returns the reference graph node for the module to which the element belongs.
java.util.Collection<RefElement>	getOutReferences() Returns the collection of references from this element to other elements.
SmartPsiElementPointer	getPointer()
default PsiElement	getPsiElement() Returns the PSI element corresponding to the node.
boolean	isEntry() Checks if the element is an entry point for reachability analysis.
boolean	isPermanentEntry() Checks if the element has been specifically marked by the user as an entry point for reachability analysis.
boolean	isReachable() Checks if a chain of references exists from one of the entry points to this element.
boolean	isReferenced() Checks if this element is referenced by any other elements.

Methods inherited from interface com.intellij.codeInspection.reference.RefEntity

accept, getChildren, getExternalName, getIcon, getName, getOwner, getQualifiedName, getRefManager, isValid

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

getModule

RefModule getModule()

Returns the reference graph node for the module to which the element belongs.

Returns:

the node for the module, or null if the element is not valid or the module was not found.

getPsiElement

default PsiElement getPsiElement()

Returns the PSI element corresponding to the node.

Returns:

the PSI element.

getElement

@Deprecated
default PsiElement getElement()

Deprecated. use getPsiElement()

getPointer

SmartPsiElementPointer getPointer()

isReachable

boolean isReachable()

Checks if a chain of references exists from one of the entry points to this element.

Returns:

true if the element is reachable from one of the entry points, false otherwise.

isReferenced

boolean isReferenced()

Checks if this element is referenced by any other elements.

Returns:

true if the element is referenced, false otherwise.

getOutReferences

java.util.Collection<RefElement> getOutReferences()

Returns the collection of references from this element to other elements.

Returns:

the collection of outgoing references.

getInReferences

java.util.Collection<RefElement> getInReferences()

Returns the collection of references from other elements to this element.

Returns:

the collection of incoming references.

isEntry

boolean isEntry()

Checks if the element is an entry point for reachability analysis.

Returns:

true if the element is an entry point, false otherwise.

isPermanentEntry

boolean isPermanentEntry()

Checks if the element has been specifically marked by the user as an entry point for reachability analysis.

Returns:

true if the element has been marked as an entry point, false otherwise.

getContainingEntry

RefElement getContainingEntry()