Package com.intellij.usageView

Class UsageInfo

java.lang.Object

com.intellij.usageView.UsageInfo

Direct Known Subclasses:

CallerUsageInfo, CallReferenceUsageInfo, ChangeSignatureParameterUsageInfo, DefaultConstructorImplicitUsageInfo, EncapsulateFieldUsageInfo, ExternalUsageInfo, FindResultUsageInfo, FixableUsageInfo, GrMethodCallUsageInfo, ImplementingClassUsageInfo, InExprUsageInfo, InheritanceToDelegationUsageInfo, InheritorUsageInfo, InternalUsageInfo, InternalUsageInfo, JavadocUsageInfo, MethodCallUsageInfo, MethodCallUsageInfo, MethodReferenceUsageInfo, MethodToMoveUsageInfo, MoveRenameUsageInfo, NoConstructorClassUsageInfo, NoLongerOverridingSubClassMethodUsageInfo, OtherLanguageUsageInfo, OverriderUsageInfo, OverridingMethodUsageInfo, RecordGetterDeclarationUsageInfo, RenameVariableUsageInfo, SafeDeleteUsageInfo, SelfUsageInfo, TurnToSuperReferenceUsageInfo, TypeMigrationUsageInfo

public class UsageInfo
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static UsageInfo[]	EMPTY_ARRAY
boolean	isNonCodeUsage
protected boolean	myDynamicUsage

Constructor Summary

Constructors

Constructor and Description
UsageInfo(PsiElement element)
UsageInfo(PsiElement element, boolean isNonCodeUsage)
UsageInfo(PsiElement element, int startOffset, int endOffset)
UsageInfo(PsiElement originalElement, int startOffset, int endOffset, boolean isNonCodeUsage)
UsageInfo(PsiFile psiFile)
UsageInfo(PsiQualifiedReferenceElement reference)
UsageInfo(PsiReference reference)
UsageInfo(SmartPsiElementPointer<?> smartPointer, SmartPsiFileRange psiFileRange, boolean dynamicUsage, boolean nonCodeUsage)

Method Summary

Modifier and Type	Method and Description
int	compareToByStartOffset(UsageInfo info)
UsageInfo	copy()
boolean	equals(java.lang.Object o)
PsiElement	getElement()
PsiFile	getFile()
int	getNavigationOffset()
Segment	getNavigationRange()
Project	getProject()
SmartPsiFileRange	getPsiFileRange()
ProperTextRange	getRangeInElement()
PsiReference	getReference()
Segment	getSegment()
SmartPsiElementPointer<?>	getSmartPointer()
java.lang.String	getTooltipText() Override this method if you want a tooltip to be displayed for this usage
VirtualFile	getVirtualFile()
int	hashCode()
boolean	isDynamicUsage()
protected boolean	isFileOrBinary()
boolean	isNonCodeUsage()
boolean	isValid()
boolean	isWritable()
void	setDynamicUsage(boolean dynamicUsage)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final UsageInfo[] EMPTY_ARRAY

isNonCodeUsage

public final boolean isNonCodeUsage

myDynamicUsage

protected boolean myDynamicUsage

Constructor Detail

UsageInfo

public UsageInfo(PsiElement originalElement,
                 int startOffset,
                 int endOffset,
                 boolean isNonCodeUsage)

UsageInfo

public UsageInfo(SmartPsiElementPointer<?> smartPointer,
                 SmartPsiFileRange psiFileRange,
                 boolean dynamicUsage,
                 boolean nonCodeUsage)

UsageInfo

public UsageInfo(PsiFile psiFile)

UsageInfo

public UsageInfo(PsiElement element,
                 boolean isNonCodeUsage)

UsageInfo

public UsageInfo(PsiElement element,
                 int startOffset,
                 int endOffset)

UsageInfo

public UsageInfo(PsiReference reference)

UsageInfo

public UsageInfo(PsiQualifiedReferenceElement reference)

UsageInfo

public UsageInfo(PsiElement element)

Method Detail

getSmartPointer

public SmartPsiElementPointer<?> getSmartPointer()

getPsiFileRange

public SmartPsiFileRange getPsiFileRange()

isNonCodeUsage

public boolean isNonCodeUsage()

setDynamicUsage

public void setDynamicUsage(boolean dynamicUsage)

getElement

public PsiElement getElement()

getReference

public PsiReference getReference()

getRangeInElement

public ProperTextRange getRangeInElement()

Returns:

range in element

getTooltipText

public java.lang.String getTooltipText()

Override this method if you want a tooltip to be displayed for this usage

getNavigationOffset

public int getNavigationOffset()

getNavigationRange

public Segment getNavigationRange()

isValid

public boolean isValid()

isFileOrBinary

protected boolean isFileOrBinary()

getSegment

public Segment getSegment()

compareToByStartOffset

public int compareToByStartOffset(UsageInfo info)

getProject

public Project getProject()

isWritable

public final boolean isWritable()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFile

public PsiFile getFile()

getVirtualFile

public VirtualFile getVirtualFile()

isDynamicUsage

public boolean isDynamicUsage()

copy

public UsageInfo copy()