|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a particular search query (in a Java example, a query might
be "find all occurrences of 'foo' in workspace"). When it's run method is
called, the query places any results it finds in the
ISearchResult
that can be accessed via getSearchResult().
Note that getSearchResult
may be called at any time, even
before the run()
method has been called. An empty search
result should be returned in that case.
Clients may implement this interface.
Method Summary | |
---|---|
boolean |
canRerun()
Returns whether the query can be run more than once. |
boolean |
canRunInBackground()
Returns whether this query can be run in the background. |
String |
getLabel()
Returns a user readable label for this query. |
ISearchResult |
getSearchResult()
Returns the search result associated with this query. |
IStatus |
run(IProgressMonitor monitor)
This is the method that actually does the work, i.e. finds the results of the search query. |
Method Detail |
public IStatus run(IProgressMonitor monitor) throws OperationCanceledException
monitor
- the progress monitor to be used
OperationCanceledException
- Thrown when the search query has been canceled.public String getLabel()
Job
name if this query is executed in
the background. Note that progress notification (for example, the number
of matches found) should be done via the progress monitor passed into the
run(IProgressMonitor)
method
public boolean canRerun()
false
.
public boolean canRunInBackground()
public ISearchResult getSearchResult()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.