public class UpdateSearchScope extends Object
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.
UpdateSearchRequest
Constructor and Description |
---|
UpdateSearchScope()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addSearchSite(String label,
URL siteURL,
String[] categoriesToSkip)
Adds the site to scan to the search scope.
|
IUpdateSearchSite[] |
getSearchSites()
Returns the sites that should be visited during the search.
|
URL |
getUpdateMapURL()
Returns the optional URL of the update map file.
|
boolean |
isFeatureProvidedSitesEnabled()
In addition to the sites added by addSearchSite(), features contribute their own update url's.
|
void |
setFeatureProvidedSitesEnabled(boolean enable)
Enable or disable searching of feature provided update sites.
|
void |
setUpdateMapURL(URL url)
Sets the optional URL of the update map file.
|
public void setUpdateMapURL(URL url)
url
- the url of the Java properties file that
contains the redirection information.public URL getUpdateMapURL()
public void addSearchSite(String label, URL siteURL, String[] categoriesToSkip)
label
- the presentation name of the site to visit.siteURL
- the URL of the site to visit.categoriesToSkip
- an array of category names that should be skipped or null if all features should be considered.public IUpdateSearchSite[] getSearchSites()
public boolean isFeatureProvidedSitesEnabled()
public void setFeatureProvidedSitesEnabled(boolean enable)
enable
- false to disable searching of feature provided sites. By default, these sites are searched.Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.