|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.core.search.SearchRequestor
Collects the results from a search engine query.
Clients implement a subclass to pass to SearchEngine.search
and implement the acceptSearchMatch(SearchMatch)
method, and
possibly override other life cycle methods.
The search engine calls beginReporting()
when a search starts,
then calls acceptSearchMatch(...)
for each search result, and
finally calls endReporting()
. The order of the search results
is unspecified and may vary from request to request; when displaying results,
clients should not rely on the order but should instead arrange the results
in an order that would be more meaningful to the user.
SearchEngine
Constructor Summary | |
---|---|
SearchRequestor()
|
Method Summary | |
---|---|
abstract void |
acceptSearchMatch(SearchMatch match)
Accepts the given search match. |
void |
beginReporting()
Notification sent before starting the search action. |
void |
endReporting()
Notification sent after having completed the search action. |
void |
enterParticipant(SearchParticipant participant)
Intermediate notification sent when the given participant starts to contribute. |
void |
exitParticipant(SearchParticipant participant)
Intermediate notification sent when the given participant is finished contributing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SearchRequestor()
Method Detail |
public abstract void acceptSearchMatch(SearchMatch match) throws CoreException
match
- the found match
CoreException
public void beginReporting()
The default implementation of this method does nothing. Subclasses may override.
public void endReporting()
The default implementation of this method does nothing. Subclasses may override.
public void enterParticipant(SearchParticipant participant)
The default implementation of this method does nothing. Subclasses may override.
participant
- the participant that is starting to contributepublic void exitParticipant(SearchParticipant participant)
The default implementation of this method does nothing. Subclasses may override.
participant
- the participant that finished contributing
|
Eclipse JDT Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |