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
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
ConstructorsConstructorDescriptionReferenceMatch
(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean insideDocComment, SearchParticipant participant, org.eclipse.core.resources.IResource resource) Creates a new reference match. -
Method Summary
Modifier and TypeMethodDescriptionfinal IJavaElement
Returns the local element of this search match, ornull
if none.final void
setLocalElement
(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 Details
-
ReferenceMatch
public ReferenceMatch(IJavaElement enclosingElement, int accuracy, int offset, int length, boolean insideDocComment, SearchParticipant participant, org.eclipse.core.resources.IResource resource) Creates a new reference match.- Parameters:
enclosingElement
- the inner-most enclosing member that references this java elementaccuracy
- one ofSearchMatch.A_ACCURATE
orSearchMatch.A_INACCURATE
offset
- the offset the match starts at, or -1 if unknownlength
- the length of the match, or -1 if unknowninsideDocComment
-true
if this search match is inside a doc comment, andfalse
otherwiseparticipant
- the search participant that created the matchresource
- the resource of the element
-
-
Method Details
-
getLocalElement
Returns the local element of this search match, ornull
if none. A local element is the inner-most element that contains the reference and that is not reachable by navigating from the root of theIJavaModel
usingIParent.getChildren()
.Known element types for local elements are
IJavaElement.ANNOTATION
,IJavaElement.LOCAL_VARIABLE
andIJavaElement.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 theparent
chain of this local element eventually leads to the element fromSearchMatch.getElement()
.The local element being an
IAnnotation
is 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 oneMethodReferenceMatch
match whose local element is theIAnnotation
'Annot
'.
- searching for the references to the type
Deprecated
inpublic class Test { @Deprecated void method() {} }
will return oneTypeReferenceMatch
match whose local element is theIAnnotation
'Deprecated
'.
- searching for the references to the field
CONST
in@Num(number= Num.CONST) @interface Num { public static final int CONST= 42; int number(); }
will return oneFieldReferenceMatch
match whose local element is theIAnnotation
'Num
'.
A local element may also be a
ILocalVariable
whose type is the referenced type. For example,- searching for the references to the type
Test
inpublic class Test { void foo() { Test local; } }
will return oneTypeReferenceMatch
match whose local element is theILocalVariable
'local
'.
ITypeParameter
that extends the referenced type. For example,- searching for the references to the type
Test
inpublic class X< T extends Test> { }
will return oneTypeReferenceMatch
match whose local element is theITypeParameter
'T
'.
- Returns:
- the local element of this search match, or
null
if none. - Since:
- 3.4
- searching for the references to the method
-
setLocalElement
Store the local element in the match.- Parameters:
element
- The local element to be stored- Since:
- 3.5
-