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, setWS
arrayTypeFor, arrayTypeFor, assertIsWriteable, getPropertyName, getResourceBundle, isReadOnly, markListReferenceReadOnly, markReferenceReadOnly, resolveListReference, resolveNLString, resolveReference, resolveURL
getAdapter
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAffinityFeature, getApplication, getLabel, getPrimaryPluginID, getProvider, isExclusive, isPatch, isPrimary
getNL, getOS, getOSArch, getWS
getAdapter
public static final String FEATURE_FILE
public static final String FEATURE_XML
public boolean equals(Object object)
equals
in class FeatureModel
object
- feature object to compare withtrue
if the two features are equal,
false
otherwisepublic VersionedIdentifier getVersionedIdentifier()
getVersionedIdentifier
in interface IFeature
IFeature.getVersionedIdentifier()
public ISite getSite()
getSite
in interface IFeature
IFeature.getSite()
public URL getURL()
getURL
in interface IFeature
IFeature.getURL()
public IURLEntry getUpdateSiteEntry()
getUpdateSiteEntry
in interface IFeature
null
.IFeature.getUpdateSiteEntry()
public IURLEntry[] getDiscoverySiteEntries()
getDiscoverySiteEntries
in interface IFeature
IFeature.getDiscoverySiteEntries()
public IInstallHandlerEntry getInstallHandlerEntry()
getInstallHandlerEntry
in interface IFeature
null
if
none was specifiedIFeature.getInstallHandlerEntry()
public IURLEntry getDescription()
getDescription
in interface IFeature
null
.IFeature.getDescription()
public IURLEntry getCopyright()
getCopyright
in interface IFeature
null
.IFeature.getCopyright()
public IURLEntry getLicense()
getLicense
in interface IFeature
null
.IFeature.getLicense()
public URL getImage()
getImage
in interface IFeature
null
.IFeature.getImage()
public IImport[] getRawImports()
getRawImports
in interface IFeature
IFeature.getRawImports()
public IFeatureReference install(IFeature targetFeature, IVerificationListener verificationListener, IProgressMonitor progress) throws InstallAbortedException, CoreException
install
in interface IFeature
InstallAbortedException
- when the user cancels the installCoreException
IFeature.install(IFeature, IVerificationListener, IProgressMonitor)
public IFeatureReference install(IFeature targetFeature, IFeatureReference[] optionalfeatures, IVerificationListener verificationListener, IProgressMonitor progress) throws InstallAbortedException, CoreException
install
in interface IFeature
optionalfeatures
- the optional features to be installedInstallAbortedException
- when the user cancels the installCoreException
IFeature.install(IFeature, IVerificationListener, IProgressMonitor)
public IPluginEntry[] getRawPluginEntries()
getRawPluginEntries
in interface IFeature
IFeature.getPluginEntries()
public int getPluginEntryCount()
getPluginEntryCount
in interface IFeature
IFeature.getPluginEntryCount()
public INonPluginEntry[] getRawNonPluginEntries()
getRawNonPluginEntries
in interface IFeature
IFeature.getNonPluginEntries()
public int getNonPluginEntryCount()
getNonPluginEntryCount
in interface IFeature
IFeature.getNonPluginEntryCount()
public IIncludedFeatureReference[] getRawIncludedFeatureReferences() throws CoreException
getRawIncludedFeatureReferences
in interface IFeature
CoreException
public long getDownloadSize()
getDownloadSize
in interface IFeature
IFeature.getDownloadSize()
public long getInstallSize()
getInstallSize
in interface IFeature
IFeature.getInstallSize()
public IFeatureContentProvider getFeatureContentProvider() throws CoreException
getFeatureContentProvider
in interface IFeature
CoreException
IFeature.getFeatureContentProvider()
public IFeatureContentConsumer getFeatureContentConsumer() throws CoreException
getFeatureContentConsumer
in interface IFeature
CoreException
IFeature.getFeatureContentConsumer()
public void setSite(ISite site) throws CoreException
setSite
in interface IFeature
site
- the siteCoreException
- site for this feature is already setIFeature.setSite(ISite)
public void setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
setFeatureContentProvider
in interface IFeature
featureContentProvider
- content providerIFeature.setFeatureContentProvider(IFeatureContentProvider)
public String toString()
public IIncludedFeatureReference[] getIncludedFeatureReferences() throws CoreException
IFeature
Sitemanager
getIncludedFeatureReferences
in interface IFeature
CoreException
IFeature.getRawIncludedFeatureReferences()
public INonPluginEntry[] getNonPluginEntries()
IFeature
Sitemanager
getNonPluginEntries
in interface IFeature
IFeature.getRawNonPluginEntries()
public IPluginEntry[] getPluginEntries()
IFeature
Sitemanager
getPluginEntries
in interface IFeature
IFeature.getRawPluginEntries()
public IImport[] getImports()
IFeature
Sitemanager
getImports
in interface IFeature
IFeature.getImports()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.