public class Feature extends FeatureModel implements IFeature
This class may be instantiated or subclassed by clients.
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.
IFeature,
FeatureModel| Modifier and Type | Field and Description |
|---|---|
static String |
FEATURE_FILE
Simple file name of the default feature manifest file
|
static String |
FEATURE_XML
File extension of the default feature manifest file
|
SEARCH_LOCATION_BOTH, SEARCH_LOCATION_DEFAULT, SEARCH_LOCATION_FEATURE, STATUS_AMBIGUOUS, STATUS_DISABLED, STATUS_HAPPY, STATUS_UNHAPPY| Constructor and Description |
|---|
Feature()
Feature default constructor
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object object)
Compares two features for equality
|
IURLEntry |
getCopyright()
Returns the copyright information for the feature.
|
IURLEntry |
getDescription()
Returns the feature description.
|
IURLEntry[] |
getDiscoverySiteEntries()
Return an array of information entries referencing locations of other
update sites.
|
long |
getDownloadSize()
Returns the download size of the feature, if it can be determined.
|
IFeatureContentConsumer |
getFeatureContentConsumer()
Returns the content consumer for this feature.
|
IFeatureContentProvider |
getFeatureContentProvider()
Returns the content provider for this feature.
|
URL |
getImage()
Return optional image for the feature.
|
IImport[] |
getImports()
Return a list of plug-in dependencies for this feature.
|
IIncludedFeatureReference[] |
getIncludedFeatureReferences()
Returns an array of feature references included by this feature
filtered by the operating system, windowing system and architecture system
set in
Sitemanager |
IInstallHandlerEntry |
getInstallHandlerEntry()
Returns and optional custom install handler entry.
|
long |
getInstallSize()
Returns the install size of the feature, if it can be determined.
|
IURLEntry |
getLicense()
Returns the license information for the feature.
|
INonPluginEntry[] |
getNonPluginEntries()
Returns an array of non-plug-in entries referenced by this feature
filtered by the operating system, windowing system and architecture system
set in
Sitemanager |
int |
getNonPluginEntryCount()
Returns the count of referenced non-plug-in entries.
|
IPluginEntry[] |
getPluginEntries()
Returns an array of plug-in entries referenced by this feature
filtered by the operating system, windowing system and architecture system
set in
Sitemanager |
int |
getPluginEntryCount()
Returns the count of referenced plug-in entries.
|
IImport[] |
getRawImports()
Return a list of plug-in dependencies for this feature.
|
IIncludedFeatureReference[] |
getRawIncludedFeatureReferences()
Returns an array of feature references included by this feature
|
INonPluginEntry[] |
getRawNonPluginEntries()
Returns an array of non-plug-in entries referenced by this feature
|
IPluginEntry[] |
getRawPluginEntries()
Returns an array of plug-in entries referenced by this feature
|
ISite |
getSite()
Returns the site this feature is associated with.
|
IURLEntry |
getUpdateSiteEntry()
Returns an information entry referencing the location of the
feature update site.
|
URL |
getURL()
Returns the feature URL.
|
VersionedIdentifier |
getVersionedIdentifier()
Returns the feature identifier.
|
IFeatureReference |
install(IFeature targetFeature,
IFeatureReference[] optionalfeatures,
IVerificationListener verificationListener,
IProgressMonitor progress)
Install the contents of this feature into the specified target feature.
|
IFeatureReference |
install(IFeature targetFeature,
IVerificationListener verificationListener,
IProgressMonitor progress)
Install the contents of this feature into the specified target feature.
|
void |
setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
Sets the content provider for this feature.
|
void |
setSite(ISite site)
Sets the site for this feature.
|
String |
toString()
Return the string representation of this fetaure
|
addDiscoverySiteEntryModel, addImportModel, addIncludedFeatureReferenceModel, addNonPluginEntryModel, addPluginEntryModel, getAffinityFeature, getApplication, getCopyrightModel, getDescriptionModel, getDiscoverySiteEntryModels, getFeatureIdentifier, getFeatureIncluded, getFeatureIncludeVersionedIdentifier, getFeatureVersion, getImageURL, getImageURLString, getImportModels, getInstallHandlerModel, getLabel, getLabelNonLocalized, getLicenseModel, getNL, getNonPluginEntryModels, getOS, getOSArch, getPluginEntryModels, getPrimaryPluginID, getProvider, getProviderNonLocalized, getUpdateSiteEntryModel, getWS, isExclusive, isPatch, isPrimary, markReadOnly, removeDiscoverySiteEntryModel, removeImportModel, removeNonPluginEntryModel, removePluginEntryModel, resolve, setAffinityFeature, setApplication, setArch, setCopyrightModel, setDescriptionModel, setDiscoverySiteEntryModels, setExclusive, setFeatureIdentifier, setFeatureVersion, setImageURLString, setImportModels, setInstallHandlerModel, setLabel, setLicenseModel, setNL, setNonPluginEntryModels, setOS, setPluginEntryModels, setPrimary, setPrimaryPluginID, setProvider, setUpdateSiteEntryModel, setWSarrayTypeFor, arrayTypeFor, assertIsWriteable, getPropertyName, getResourceBundle, isReadOnly, markListReferenceReadOnly, markReferenceReadOnly, resolveListReference, resolveNLString, resolveReference, resolveURLgetAdapterclone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetAffinityFeature, getApplication, getLabel, getPrimaryPluginID, getProvider, isExclusive, isPatch, isPrimarygetNL, getOS, getOSArch, getWSgetAdapterpublic static final String FEATURE_FILE
public static final String FEATURE_XML
public boolean equals(Object object)
equals in class FeatureModelobject - feature object to compare withtrue if the two features are equal,
false otherwisepublic VersionedIdentifier getVersionedIdentifier()
getVersionedIdentifier in interface IFeatureIFeature.getVersionedIdentifier()public ISite getSite()
getSite in interface IFeatureIFeature.getSite()public URL getURL()
getURL in interface IFeatureIFeature.getURL()public IURLEntry getUpdateSiteEntry()
getUpdateSiteEntry in interface IFeaturenull.IFeature.getUpdateSiteEntry()public IURLEntry[] getDiscoverySiteEntries()
getDiscoverySiteEntries in interface IFeatureIFeature.getDiscoverySiteEntries()public IInstallHandlerEntry getInstallHandlerEntry()
getInstallHandlerEntry in interface IFeaturenull if
none was specifiedIFeature.getInstallHandlerEntry()public IURLEntry getDescription()
getDescription in interface IFeaturenull.IFeature.getDescription()public IURLEntry getCopyright()
getCopyright in interface IFeaturenull.IFeature.getCopyright()public IURLEntry getLicense()
getLicense in interface IFeaturenull.IFeature.getLicense()public URL getImage()
getImage in interface IFeaturenull.IFeature.getImage()public IImport[] getRawImports()
getRawImports in interface IFeatureIFeature.getRawImports()public IFeatureReference install(IFeature targetFeature, IVerificationListener verificationListener, IProgressMonitor progress) throws InstallAbortedException, CoreException
install in interface IFeatureInstallAbortedException - when the user cancels the installCoreExceptionIFeature.install(IFeature, IVerificationListener, IProgressMonitor)public IFeatureReference install(IFeature targetFeature, IFeatureReference[] optionalfeatures, IVerificationListener verificationListener, IProgressMonitor progress) throws InstallAbortedException, CoreException
install in interface IFeatureoptionalfeatures - the optional features to be installedInstallAbortedException - when the user cancels the installCoreExceptionIFeature.install(IFeature, IVerificationListener, IProgressMonitor)public IPluginEntry[] getRawPluginEntries()
getRawPluginEntries in interface IFeatureIFeature.getPluginEntries()public int getPluginEntryCount()
getPluginEntryCount in interface IFeatureIFeature.getPluginEntryCount()public INonPluginEntry[] getRawNonPluginEntries()
getRawNonPluginEntries in interface IFeatureIFeature.getNonPluginEntries()public int getNonPluginEntryCount()
getNonPluginEntryCount in interface IFeatureIFeature.getNonPluginEntryCount()public IIncludedFeatureReference[] getRawIncludedFeatureReferences() throws CoreException
getRawIncludedFeatureReferences in interface IFeatureCoreExceptionpublic long getDownloadSize()
getDownloadSize in interface IFeatureIFeature.getDownloadSize()public long getInstallSize()
getInstallSize in interface IFeatureIFeature.getInstallSize()public IFeatureContentProvider getFeatureContentProvider() throws CoreException
getFeatureContentProvider in interface IFeatureCoreExceptionIFeature.getFeatureContentProvider()public IFeatureContentConsumer getFeatureContentConsumer() throws CoreException
getFeatureContentConsumer in interface IFeatureCoreExceptionIFeature.getFeatureContentConsumer()public void setSite(ISite site) throws CoreException
setSite in interface IFeaturesite - the siteCoreException - site for this feature is already setIFeature.setSite(ISite)public void setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
setFeatureContentProvider in interface IFeaturefeatureContentProvider - content providerIFeature.setFeatureContentProvider(IFeatureContentProvider)public String toString()
public IIncludedFeatureReference[] getIncludedFeatureReferences() throws CoreException
IFeatureSitemanagergetIncludedFeatureReferences in interface IFeatureCoreExceptionIFeature.getRawIncludedFeatureReferences()public INonPluginEntry[] getNonPluginEntries()
IFeatureSitemanagergetNonPluginEntries in interface IFeatureIFeature.getRawNonPluginEntries()public IPluginEntry[] getPluginEntries()
IFeatureSitemanagergetPluginEntries in interface IFeatureIFeature.getRawPluginEntries()public IImport[] getImports()
IFeatureSitemanagergetImports in interface IFeatureIFeature.getImports()Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.