| java.lang.Object
 org.eclipse.jdt.core.search.SearchRequestor
All known Subclasses: org.eclipse.jdt.internal.corext.callhierarchy.MethodReferencesSearchRequestor, org.eclipse.jdt.internal.ui.search.NewSearchResultCollector, org.eclipse.jdt.internal.corext.refactoring.CollectingSearchRequestor, org.eclipse.jdt.internal.ui.refactoring.nls.search.NLSSearchResultRequestor,
| SearchRequestor | | abstract public class SearchRequestor (Code) | | Collects the results from a search engine query.
Clients implement a subclass to pass to SearchEngine.search
and implement the
SearchRequestor.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.
See Also: SearchEngine
since:
3.0 |
| Method Summary | |
| abstract public void | acceptSearchMatch(SearchMatch match)
Accepts the given search match. | | public void | beginReporting()
Notification sent before starting the search action.
Typically, this would tell a search requestor to clear previously
recorded search results.
The default implementation of this method does nothing. | | public void | endReporting()
Notification sent after having completed the search action.
Typically, this would tell a search requestor collector that no more
results will be forthcomping in this search.
The default implementation of this method does nothing. | | public void | enterParticipant(SearchParticipant participant)
Intermediate notification sent when the given participant starts to
contribute.
The default implementation of this method does nothing. | | public void | exitParticipant(SearchParticipant participant)
Intermediate notification sent when the given participant is finished
contributing.
The default implementation of this method does nothing. |
| acceptSearchMatch | | abstract public void acceptSearchMatch(SearchMatch match) throws CoreException(Code) | | Accepts the given search match.
Parameters:
match - the found match
throws:
CoreException - |
| beginReporting | | public void beginReporting()(Code) | | Notification sent before starting the search action.
Typically, this would tell a search requestor to clear previously
recorded search results.
The default implementation of this method does nothing. Subclasses
may override.
|
| endReporting | | public void endReporting()(Code) | | Notification sent after having completed the search action.
Typically, this would tell a search requestor collector that no more
results will be forthcomping in this search.
The default implementation of this method does nothing. Subclasses
may override.
|
| enterParticipant | | public void enterParticipant(SearchParticipant participant)(Code) | | Intermediate notification sent when the given participant starts to
contribute.
The default implementation of this method does nothing. Subclasses
may override.
Parameters:
participant - the participant that is starting to contribute |
| exitParticipant | | public void exitParticipant(SearchParticipant participant)(Code) | | Intermediate notification sent when the given participant is finished
contributing.
The default implementation of this method does nothing. Subclasses
may override.
Parameters:
participant - the participant that finished contributing |
|
|