Package org.eclipse.jdt.core.search
Class ReferenceMatch
- java.lang.Object
-
- org.eclipse.jdt.core.search.SearchMatch
-
- org.eclipse.jdt.core.search.ReferenceMatch
-
- Direct Known Subclasses:
FieldReferenceMatch,MethodReferenceMatch,ModuleReferenceMatch,PackageReferenceMatch,TypeReferenceMatch
public abstract class ReferenceMatch extends SearchMatch
An abstract Java search match that represents a reference.- Since:
- 3.4
-
-
Field Summary
-
Fields inherited from class org.eclipse.jdt.core.search.SearchMatch
A_ACCURATE, A_INACCURATE
-
-
Constructor Summary
Constructors Constructor Description ReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean insideDocComment, SearchParticipant participant, IResource resource)Creates a new reference match.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IJavaElementgetLocalElement()Returns the local element of this search match, ornullif none.voidsetLocalElement(IJavaElement element)Store the local element in the match.-
Methods inherited from class org.eclipse.jdt.core.search.SearchMatch
getAccuracy, getElement, getLength, getOffset, getParticipant, getResource, getRule, isEquivalent, isErasure, isExact, isImplicit, isInsideDocComment, isRaw, setAccuracy, setElement, setImplicit, setInsideDocComment, setLength, setOffset, setParticipant, setRaw, setResource, setRule, toString
-
-
-
-
Constructor Detail
-
ReferenceMatch
public ReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean insideDocComment, SearchParticipant participant, IResource resource)
Creates a new reference match.- Parameters:
enclosingElement- the inner-most enclosing member that references this java elementaccuracy- one ofSearchMatch.A_ACCURATEorSearchMatch.A_INACCURATEoffset- the offset the match starts at, or -1 if unknownlength- the length of the match, or -1 if unknowninsideDocComment-trueif this search match is inside a doc comment, andfalseotherwiseparticipant- the search participant that created the matchresource- the resource of the element
-
-
Method Detail
-
getLocalElement
public final IJavaElement getLocalElement()
Returns the local element of this search match, ornullif none. A local element is the inner-most element that contains the reference and that is not reachable by navigating from the root of theIJavaModelusingIParent.getChildren().Known element types for local elements are
IJavaElement.ANNOTATION,IJavaElement.LOCAL_VARIABLEandIJavaElement.TYPE_PARAMETER.
However clients should not assume that this set of element types is closed as other types of elements may be returned in the future, e.g. if new types of elements are added in the Java model. Clients can only assume that theparentchain of this local element eventually leads to the element fromSearchMatch.getElement().The local element being an
IAnnotationis the most usual case. For example,- searching for the references to the method
Annot.clazz()inpublic class Test { void method() { @Annot(clazz=Test.class) int x; } }will return oneMethodReferenceMatchmatch whose local element is theIAnnotation'Annot'.
- searching for the references to the type
Deprecatedinpublic class Test { @Deprecated void method() {} }will return oneTypeReferenceMatchmatch whose local element is theIAnnotation'Deprecated'.
- searching for the references to the field
CONSTin@Num(number= Num.CONST) @interface Num { public static final int CONST= 42; int number(); }will return oneFieldReferenceMatchmatch whose local element is theIAnnotation'Num'.
A local element may also be a
ILocalVariablewhose type is the referenced type. For example,- searching for the references to the type
Testinpublic class Test { void foo() { Test local; } }will return oneTypeReferenceMatchmatch whose local element is theILocalVariable'local'.
ITypeParameterthat extends the referenced type. For example,- searching for the references to the type
Testinpublic class X< T extends Test> { }will return oneTypeReferenceMatchmatch whose local element is theITypeParameter'T'.
- Returns:
- the local element of this search match, or
nullif none. - Since:
- 3.4
- searching for the references to the method
-
setLocalElement
public final void setLocalElement(IJavaElement element)
Store the local element in the match.- Parameters:
element- The local element to be stored- Since:
- 3.5
-
-