Eclipse JDT
Release 3.0

org.eclipse.jdt.core.search
Class SearchMatch

java.lang.Object
  extended byorg.eclipse.jdt.core.search.SearchMatch
Direct Known Subclasses:
FieldDeclarationMatch, FieldReferenceMatch, LocalVariableDeclarationMatch, LocalVariableReferenceMatch, MethodDeclarationMatch, MethodReferenceMatch, PackageDeclarationMatch, PackageReferenceMatch, TypeDeclarationMatch, TypeReferenceMatch

public class SearchMatch
extends Object

A search match represents the result of a search query. Search matches may be accurate (A_ACCURATE) or they might be merely potential matches (A_INACCURATE). The latter occurs when a compile-time problem prevents the search engine from completely resolving the match.

This class is intended to be instantiated and subclassed by clients.

Since:
3.0
See Also:
SearchEngine.search(SearchPattern, SearchParticipant[], IJavaSearchScope, SearchRequestor, org.eclipse.core.runtime.IProgressMonitor)

Field Summary
static int A_ACCURATE
          The search result corresponds an exact match of the search pattern.
static int A_INACCURATE
          The search result is potentially a match for the search pattern, but the search engine is unable to fully check it (for example, because there are errors in the code or the classpath are not correctly set).
 
Constructor Summary
SearchMatch(IJavaElement element, int accuracy, int offset, int length, SearchParticipant participant, org.eclipse.core.resources.IResource resource)
          Creates a new search match.
 
Method Summary
 int getAccuracy()
          Returns the accuracy of this search match.
 Object getElement()
          Returns the element of this search match.
 int getLength()
          Returns the length of this search match.
 int getOffset()
          Returns the offset of this search match.
 SearchParticipant getParticipant()
          Returns the search participant which issued this search match.
 org.eclipse.core.resources.IResource getResource()
          Returns the resource containing this search match.
 boolean isInsideDocComment()
          Returns whether this search match is inside a doc comment of a Java source file.
 void setAccuracy(int accuracy)
          Sets the accuracy of this match.
 void setElement(Object element)
          Sets the element of this search match.
 void setInsideDocComment(boolean insideDoc)
          Sets whether this search match is inside a doc comment of a Java source file.
 void setLength(int length)
          Sets the length of this search match.
 void setOffset(int offset)
          Sets the offset of this search match.
 void setParticipant(SearchParticipant participant)
          Sets the participant of this match.
 void setResource(org.eclipse.core.resources.IResource resource)
          Sets the resource of this match.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

A_ACCURATE

public static final int A_ACCURATE
The search result corresponds an exact match of the search pattern.

See Also:
Constant Field Values

A_INACCURATE

public static final int A_INACCURATE
The search result is potentially a match for the search pattern, but the search engine is unable to fully check it (for example, because there are errors in the code or the classpath are not correctly set).

See Also:
Constant Field Values
Constructor Detail

SearchMatch

public SearchMatch(IJavaElement element,
                   int accuracy,
                   int offset,
                   int length,
                   SearchParticipant participant,
                   org.eclipse.core.resources.IResource resource)
Creates a new search match.

Note that isInsideDocComment() defaults to false.

Parameters:
element - the element that encloses or corresponds to the match, or null if none
accuracy - one of A_ACCURATE or A_INACCURATE
offset - the offset the match starts at, or -1 if unknown
length - the length of the match, or -1 if unknown
participant - the search participant that created the match
resource - the resource of the element, or null if none
Method Detail

getAccuracy

public final int getAccuracy()
Returns the accuracy of this search match.

Returns:
one of A_ACCURATE or A_INACCURATE

getElement

public final Object getElement()
Returns the element of this search match. In case of a reference match, this is the inner-most enclosing element of the reference. In case of a declaration match, this is the declaration.

Returns:
the element of the search match, or null if none

getLength

public final int getLength()
Returns the length of this search match.

Returns:
the length of this search match, or -1 if unknown

getOffset

public final int getOffset()
Returns the offset of this search match.

Returns:
the offset of this search match, or -1 if unknown

getParticipant

public final SearchParticipant getParticipant()
Returns the search participant which issued this search match.

Returns:
the participant which issued this search match

getResource

public final org.eclipse.core.resources.IResource getResource()
Returns the resource containing this search match.

Returns:
the resource of the match, or null if none

isInsideDocComment

public final boolean isInsideDocComment()
Returns whether this search match is inside a doc comment of a Java source file.

Returns:
true if this search match is inside a doc comment, and false otherwise

setAccuracy

public final void setAccuracy(int accuracy)
Sets the accuracy of this match.

Parameters:
accuracy - one of A_ACCURATE or A_INACCURATE

setElement

public final void setElement(Object element)
Sets the element of this search match.

Parameters:
element - the element that encloses or corresponds to the match, or null if none

setLength

public final void setLength(int length)
Sets the length of this search match.

Parameters:
length - the length of the match, or -1 if unknown

setOffset

public final void setOffset(int offset)
Sets the offset of this search match.

Parameters:
offset - the offset the match starts at, or -1 if unknown

setParticipant

public final void setParticipant(SearchParticipant participant)
Sets the participant of this match.

Parameters:
participant - the search participant that created this match

setResource

public final void setResource(org.eclipse.core.resources.IResource resource)
Sets the resource of this match.

Parameters:
resource - the resource of the match, or null if none

setInsideDocComment

public final void setInsideDocComment(boolean insideDoc)
Sets whether this search match is inside a doc comment of a Java source file.

Parameters:
insideDoc - true if this search match is inside a doc comment, and false otherwise

toString

public String toString()

Eclipse JDT
Release 3.0

Copyright (c) IBM Corp. and others 2000, 2004. All Rights Reserved.