Package com.intellij.codeInspection.reference

Interface RefEntity

All Superinterfaces:

UserDataHolder

All Known Subinterfaces:

RefClass, RefDirectory, RefElement, RefField, RefFile, RefImplicitConstructor, RefJavaElement, RefJavaModule, RefMethod, RefModule, RefPackage, RefParameter, RefProject, WritableRefElement, WritableRefEntity

All Known Implementing Classes:

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

public interface RefEntity
extends UserDataHolder

Base class for nodes in the reference graph built during the global inspection pass.

See Also:

RefManager

Field Summary

Fields

Modifier and Type	Field and Description
static RefEntity[]	EMPTY_ELEMENTS_ARRAY

Method Summary

Modifier and Type	Method and Description
void	accept(RefVisitor refVisitor) Accepts the specified visitor and passes self to one of its visit methods.
java.util.List<RefEntity>	getChildren() Returns the list of children of the node.
java.lang.String	getExternalName() Returns a user-readable name for the element corresponding to the node.
javax.swing.Icon	getIcon(boolean expanded)
java.lang.String	getName() Returns the name of the node.
RefEntity	getOwner() Returns the parent of the node.
java.lang.String	getQualifiedName()
RefManager	getRefManager() Returns the reference graph manager for the node.
boolean	isValid() Checks if the element corresponding to the node is valid.

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

getUserData, putUserData

Field Detail

EMPTY_ELEMENTS_ARRAY

static final RefEntity[] EMPTY_ELEMENTS_ARRAY

Method Detail

getName

java.lang.String getName()

Returns the name of the node.

Returns:

the name of the node.

getQualifiedName

java.lang.String getQualifiedName()

getChildren

java.util.List<RefEntity> getChildren()

Returns the list of children of the node.

Returns:

the list of children.

getOwner

RefEntity getOwner()

Returns the parent of the node.

Returns:

the parent of the node.

accept

void accept(RefVisitor refVisitor)

Accepts the specified visitor and passes self to one of its visit methods.

Parameters:

refVisitor - the visitor to accept.

getExternalName

java.lang.String getExternalName()

Returns a user-readable name for the element corresponding to the node.

Returns:

the user-readable name.

isValid

boolean isValid()

Checks if the element corresponding to the node is valid.

Returns:

true if the element is valid, false otherwise.

getRefManager

RefManager getRefManager()

Returns the reference graph manager for the node.

Returns:

the reference graph element for the instance.

getIcon

javax.swing.Icon getIcon(boolean expanded)