|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Site represents a location containing some number of features (packaged or installed). Sites are treated purely as an installation and packaging construct. They do not play a role during Eclipse plug-in execution.
Clients may implement this interface. However, in most cases clients should directly instantiate or subclass the provided implementation of this interface.
Site
Field Summary | |
static String |
DEFAULT_INSTALLED_FEATURE_TYPE
Default type for an installed feature. |
static String |
DEFAULT_PACKAGED_FEATURE_TYPE
Default type for a packaged feature. |
Method Summary | |
void |
addPluginEntry(IPluginEntry pluginEntry)
Adds a new plug-in entry to this site. |
IArchiveReference[] |
getArchives()
Returns an array of plug-in and non-plug-in archives located on this site |
ICategory[] |
getCategories()
Returns an array of categories defined by the site. |
ICategory |
getCategory(String name)
Returns the named site category. |
String |
getDefaultPackagedFeatureType()
Returns the default type for a packaged feature supported by this site |
IURLEntry |
getDescription()
Returns the site description. |
long |
getDownloadSizeFor(IFeature feature)
Returns the size of the files that need to be downloaded in order to install the specified feature on this site, if it can be determined. |
IFeatureReference |
getFeatureReference(IFeature feature)
Returns a reference to the specified feature if it is installed on this site. |
IFeatureReference[] |
getFeatureReferences()
Returns an array of references to features on this site. |
long |
getInstallSizeFor(IFeature site)
Returns the size of the files that need to be installed for the specified feature on this site, if it can be determined. |
IPluginEntry[] |
getPluginEntries()
Returns an array of entries corresponding to plug-ins installed on this site. |
IPluginEntry[] |
getPluginEntriesOnlyReferencedBy(IFeature feature)
Returns an array of entries corresponding to plug-ins that are installed on this site and are referenced only by the specified feature. |
int |
getPluginEntryCount()
Returns the number of plug-ins installed on this site |
ISiteContentProvider |
getSiteContentProvider()
Returns the content provider for this site. |
String |
getType()
Return the site type. |
URL |
getURL()
Returns the site URL |
IFeatureReference |
install(IFeature feature,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Installs the specified feature on this site. |
void |
remove(IFeature feature,
IProgressMonitor monitor)
Removes (uninstalls) the specified feature from this site. |
void |
setSiteContentProvider(ISiteContentProvider siteContentProvider)
Sets the site content provider. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Field Detail |
public static final String DEFAULT_INSTALLED_FEATURE_TYPE
org.eclipse.update.core.featureTypes
extension point.
public static final String DEFAULT_PACKAGED_FEATURE_TYPE
org.eclipse.update.core.featureTypes
extension point.
Method Detail |
public URL getURL()
public String getType()
org.eclipse.update.core.siteTypes
extension point.
null
.public IURLEntry getDescription()
null
.public ICategory[] getCategories()
public ICategory getCategory(String name)
name
- category name
null
ifit does not existpublic IFeatureReference[] getFeatureReferences()
public IFeatureReference getFeatureReference(IFeature feature)
feature
- feature
null
if this feature
cannot be located on this site.public IArchiveReference[] getArchives()
public ISiteContentProvider getSiteContentProvider() throws CoreException
CoreException
public String getDefaultPackagedFeatureType()
org.eclipse.update.core.featureTypes
extension point.public IPluginEntry[] getPluginEntries()
public int getPluginEntryCount()
public void addPluginEntry(IPluginEntry pluginEntry)
pluginEntry
- plug-in entrypublic IPluginEntry[] getPluginEntriesOnlyReferencedBy(IFeature feature) throws CoreException
feature
- feature
CoreException
public long getDownloadSizeFor(IFeature feature)
feature
- candidate feature
ContentEntryModel.UNKNOWN_SIZE
public long getInstallSizeFor(IFeature site)
ContentEntryModel.UNKNOWN_SIZE
public IFeatureReference install(IFeature feature, IVerificationListener verificationListener, IProgressMonitor monitor) throws InstallAbortedException, CoreException
feature
- feature to installverificationListener
- install verification listenermonitor
- install monitor, can be null
InstallAbortedException
- when the user cancels the install
CoreException
public void remove(IFeature feature, IProgressMonitor monitor) throws CoreException
feature
- feature to removemonitor
- progress monitor
CoreException
public void setSiteContentProvider(ISiteContentProvider siteContentProvider)
siteContentProvider
- site content provider
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |