Package com.intellij.codeInspection.reference

Class RefElementImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInspection.reference.RefEntityImpl

com.intellij.codeInspection.reference.RefElementImpl

All Implemented Interfaces:

RefElement, RefEntity, WritableRefElement, WritableRefEntity, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

RefDirectoryImpl, RefFileImpl, RefJavaElementImpl, RefJavaModuleImpl

public abstract class RefElementImpl
extends RefEntityImpl
implements RefElement, WritableRefElement

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	IS_REACHABLE_MASK
protected static Logger	LOG

Fields inherited from class com.intellij.codeInspection.reference.RefEntityImpl

myChildren, myFlags, myManager

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

EMPTY_ELEMENTS_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefElementImpl(PsiFile file, RefManager manager)
protected	RefElementImpl(java.lang.String name, PsiElement element, RefManager manager)
protected	RefElementImpl(java.lang.String name, RefElement owner)

Method Summary

Modifier and Type	Method and Description
void	addInReference(RefElement refElement)
void	addOutReference(RefElement refElement)
void	addSuppression(java.lang.String text)
void	buildReferences()
RefElement	getContainingEntry()
PsiFile	getContainingFile()
java.lang.String	getExternalName() Returns a user-readable name for the element corresponding to the node.
javax.swing.Icon	getIcon(boolean expanded)
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()
PsiElement	getPsiElement() Returns the PSI element corresponding to the node.
java.lang.String	getURL()
VirtualFile	getVirtualFile()
boolean	hasSuspiciousCallers()
protected abstract void	initialize()
protected boolean	isDeleted()
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.
boolean	isSuppressed(java.lang.String... toolId)
boolean	isSuspicious()
boolean	isValid() Checks if the element corresponding to the node is valid.
void	referenceRemoved()
void	setEntry(boolean entry)
void	setPermanentEntry(boolean permanentEntry)
void	setReachable(boolean reachable)

Methods inherited from class com.intellij.codeInspection.reference.RefEntityImpl

accept, add, checkFlag, getChildren, getName, getOwner, getQualifiedName, getRefManager, removeChild, setFlag, setOwner, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

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

getElement

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

add, removeChild, setOwner

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

accept, getChildren, getName, getOwner, getQualifiedName, getRefManager

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

getUserData, putUserData

Field Detail

LOG

protected static final Logger LOG

IS_REACHABLE_MASK

protected static final int IS_REACHABLE_MASK

See Also:

Constant Field Values

Constructor Detail

RefElementImpl

protected RefElementImpl(java.lang.String name,
                         RefElement owner)

RefElementImpl

protected RefElementImpl(PsiFile file,
                         RefManager manager)

RefElementImpl

protected RefElementImpl(java.lang.String name,
                         PsiElement element,
                         RefManager manager)

Method Detail

isDeleted

protected boolean isDeleted()

isValid

public boolean isValid()

Description copied from interface: RefEntity

Checks if the element corresponding to the node is valid.

Specified by:

isValid in interface RefEntity

Returns:

true if the element is valid, false otherwise.

getIcon

public javax.swing.Icon getIcon(boolean expanded)

Specified by:

getIcon in interface RefEntity

getModule

public RefModule getModule()

Description copied from interface: RefElement

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

Specified by:

getModule in interface RefElement

Returns:

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

getExternalName

public java.lang.String getExternalName()

Description copied from interface: RefEntity

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

Specified by:

getExternalName in interface RefEntity

Overrides:

getExternalName in class RefEntityImpl

Returns:

the user-readable name.

getPsiElement

public PsiElement getPsiElement()

Description copied from interface: RefElement

Returns the PSI element corresponding to the node.

Specified by:

getPsiElement in interface RefElement

Returns:

the PSI element.

getContainingFile

public PsiFile getContainingFile()

getVirtualFile

public VirtualFile getVirtualFile()

getPointer

public SmartPsiElementPointer getPointer()

Specified by:

getPointer in interface RefElement

buildReferences

public void buildReferences()

isReachable

public boolean isReachable()

Description copied from interface: RefElement

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

Specified by:

isReachable in interface RefElement

Returns:

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

setReachable

public void setReachable(boolean reachable)

isReferenced

public boolean isReferenced()

Description copied from interface: RefElement

Checks if this element is referenced by any other elements.

Specified by:

isReferenced in interface RefElement

Returns:

true if the element is referenced, false otherwise.

hasSuspiciousCallers

public boolean hasSuspiciousCallers()

getOutReferences

public java.util.Collection<RefElement> getOutReferences()

Description copied from interface: RefElement

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

Specified by:

getOutReferences in interface RefElement

Returns:

the collection of outgoing references.

getInReferences

public java.util.Collection<RefElement> getInReferences()

Description copied from interface: RefElement

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

Specified by:

getInReferences in interface RefElement

Returns:

the collection of incoming references.

addInReference

public void addInReference(RefElement refElement)

Specified by:

addInReference in interface WritableRefElement

addOutReference

public void addOutReference(RefElement refElement)

Specified by:

addOutReference in interface WritableRefElement

setEntry

public void setEntry(boolean entry)

isEntry

public boolean isEntry()

Description copied from interface: RefElement

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

Specified by:

isEntry in interface RefElement

Returns:

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

isPermanentEntry

public boolean isPermanentEntry()

Description copied from interface: RefElement

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

Specified by:

isPermanentEntry in interface RefElement

Returns:

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

getContainingEntry

public RefElement getContainingEntry()

Specified by:

getContainingEntry in interface RefElement

setPermanentEntry

public void setPermanentEntry(boolean permanentEntry)

isSuspicious

public boolean isSuspicious()

referenceRemoved

public void referenceRemoved()

getURL

public java.lang.String getURL()

initialize

protected abstract void initialize()

addSuppression

public void addSuppression(java.lang.String text)

Specified by:

addSuppression in interface WritableRefElement

isSuppressed

public boolean isSuppressed(java.lang.String... toolId)