org.eclipse.update.search
Interface IUpdateSearchQuery
Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This
provisional API was never promoted to stable API, and may be removed from a future release of the platform.
-
public interface IUpdateSearchQuery
A search query.
Note: This class/interface is part of an interim API that is still under development and expected to
change significantly before reaching stability. It is being made available at this early stage to solicit feedback
from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
(repeatedly) as the API evolves.
-
Since:
- 3.0
getQuerySearchSite
IQueryUpdateSiteAdapter getQuerySearchSite()
-
Deprecated.
- Returns an update site adapter that should be added to the scope
while running this query. Some search category may need to
scan specific site adapter in addition to those specified in
the search scope.
-
-
Returns:
- the query-specific site adapter or null if
not specified.
run
void run(
ISite site,
String[] categoriesToSkip,
IUpdateSearchFilter filter,
IUpdateSearchResultCollector collector,
IProgressMonitor monitor)
-
Deprecated.
- Executes the query. The implementors should scan the provided
update site (skipping certain categories if provided) and
pass the matches to the result collector. The query is also
responsible for scoping and moving the provided progress monitor.
-
-
Parameters:
-
site
- the update site to scan -
categoriesToSkip
- an array of category names that need to be skipped or null if categories should not be taken into account. -
filter
- a filter to apply before passing the match to collector -
collector
- an object that is used for reporting search results -
monitor
- a progress monitor to report search progress within the provided site
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.