|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Feature defines the packaging "container" for a group of related plug-ins, plug-in fragments, and optionally non-plug-in files.
Features are treated purely as an installation and packaging construct. They do not play a role during Eclipse plug-in execution. They are simply an inclusive "manifest" of the plug-ins, fragments and other files that make up that feature. If features are logically made up of plug-ins from "sub-features", the top-level feature "manifest" must be fully resolved at packaging time.
Clients may implement this interface. However, in most cases clients should directly instantiate or subclass the provided implementation of this interface.
Feature
Field Summary | |
static int |
SEARCH_LOCATION_BOTH
Indicates the one-click update will search both the location of the nesting root feature and the location defined by the feature. |
static int |
SEARCH_LOCATION_DEFAULT
Indicates the one-click update will search the location of the nesting root feature. |
static int |
SEARCH_LOCATION_FEATURE
Indicates the one-click update will search the location defined by the feature. |
static int |
STATUS_AMBIGUOUS
Indicates a 'happy' feature A feature is considered to be 'ambiguous' in the context of a local site if all the plug-ins referenced by the feature are installed on the site and other version of any of the plug-ins are installed on any other site of the local site. |
static int |
STATUS_DISABLED
Indicates a disable feature |
static int |
STATUS_HAPPY
Indicates a 'happy' feature A feature is considered to be 'happy' in the context of a local site if all the plug-ins referenced by the feature are installed on the site and no other version of any of the plug-ins are installed on any other site of the local site. |
static int |
STATUS_UNHAPPY
Indicates an 'unhappy' feature A feature is considered to be 'unhappy' in the context of this site, if some of the plug-ins referenced by the feature are not installed on this site. |
Method Summary | |
String |
getAffinityFeature()
Returns an optional identifier of a colocation affinity feature. |
String |
getApplication()
Returns an optional identifier of an application to be used when starting up the platform with this feature as the primary feature. |
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. |
String |
getLabel()
Returns the displayable label of the feature. |
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. |
String |
getPrimaryPluginID()
Return the identifier of the primary plugin associated to this feature or null if the feature is not a primary feature. |
String |
getProvider()
Returns a displayable label identifying the provider of this feature |
IImport[] |
getRawImports()
Return a list of plug-in dependencies for this feature. |
IIncludedFeatureReference[] |
getRawIncludedFeatureReferences()
Returns an array of feature references included by this feature No filtering occurs |
INonPluginEntry[] |
getRawNonPluginEntries()
Returns an array of non-plug-in entries referenced by this feature No filtering occurs |
IPluginEntry[] |
getRawPluginEntries()
Returns an array of plug-in entries referenced by this feature No filtering occurs |
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 monitor)
Install the contents of this feature into the specified target feature. |
IFeatureReference |
install(IFeature targetFeature,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Install the contents of this feature into the specified target feature. |
boolean |
isExclusive()
Indicates whether the feature must be processed alone during installation and configuration. |
boolean |
isPatch()
Returns true if this feature is patching another feature,
false otherwise |
boolean |
isPrimary()
Indicates whether the feature can be used as a primary feature. |
void |
setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
Sets the content provider for this feature. |
void |
setSite(ISite site)
Sets the site for this feature. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Methods inherited from interface org.eclipse.update.core.IPlatformEnvironment |
getNL, getOS, getOSArch, getWS |
Field Detail |
public static final int STATUS_HAPPY
IConfiguredSite.getBrokenStatus(IFeature)
public static final int STATUS_AMBIGUOUS
IConfiguredSite.getBrokenStatus(IFeature)
public static final int STATUS_UNHAPPY
IConfiguredSite.getBrokenStatus(IFeature)
public static final int STATUS_DISABLED
IConfiguredSite.getBrokenStatus(IFeature)
public static final int SEARCH_LOCATION_DEFAULT
public static final int SEARCH_LOCATION_FEATURE
public static final int SEARCH_LOCATION_BOTH
Method Detail |
public VersionedIdentifier getVersionedIdentifier()
public ISite getSite()
public String getLabel()
null
.public URL getURL()
IFeatureFactory.createFeature(URL, ISite)
public IURLEntry getUpdateSiteEntry()
null
.public IURLEntry[] getDiscoverySiteEntries()
public String getProvider()
null
.public IInstallHandlerEntry getInstallHandlerEntry()
null
if
none was specifiedpublic IURLEntry getDescription()
null
.public IURLEntry getCopyright()
null
.public IURLEntry getLicense()
null
.public URL getImage()
null
.public IImport[] getImports()
Sitemanager
public IImport[] getRawImports()
public String getPrimaryPluginID()
null
if the feature is not a primary feature.
If the primary plugin id is not specified and the feature is a primary
feature, returns the feature identifier.null
public IFeatureReference install(IFeature targetFeature, IVerificationListener verificationListener, IProgressMonitor monitor) throws InstallAbortedException, CoreException
targetFeature
- verificationListener
- monitor
- InstallAbortedException
- when the user cancels the installCoreException
- public IFeatureReference install(IFeature targetFeature, IFeatureReference[] optionalFeatures, IVerificationListener verificationListener, IProgressMonitor monitor) throws InstallAbortedException, CoreException
targetFeature
- optionalFeatures
- the optional features to be installedverificationListener
- monitor
- InstallAbortedException
- when the user cancels the installCoreException
- public IIncludedFeatureReference[] getIncludedFeatureReferences() throws CoreException
Sitemanager
public IIncludedFeatureReference[] getRawIncludedFeatureReferences() throws CoreException
public IPluginEntry[] getPluginEntries()
Sitemanager
public IPluginEntry[] getRawPluginEntries()
public int getPluginEntryCount()
public INonPluginEntry[] getNonPluginEntries()
Sitemanager
public INonPluginEntry[] getRawNonPluginEntries()
public int getNonPluginEntryCount()
public long getDownloadSize()
ContentEntryModel.UNKNOWN_SIZE
public long getInstallSize()
ContentEntryModel.UNKNOWN_SIZE
public boolean isPrimary()
true
if this is a primary feature,
otherwise false
public boolean isExclusive()
true
if feature requires exclusive processing,
false
otherwise.public String getApplication()
org.eclipse.core.runtime.applications
extension point.null
public String getAffinityFeature()
null
.public IFeatureContentProvider getFeatureContentProvider() throws CoreException
CoreExcepton
- public IFeatureContentConsumer getFeatureContentConsumer() throws CoreException
CoreException
- UnsupportedOperationException
- public void setSite(ISite site) throws CoreException
site
- the siteCoreException
- site for this feature is already setpublic void setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
featureContentProvider
- content providerIFeatureFactory.createFeature(URL, ISite)
public boolean isPatch()
true
if this feature is patching another feature,
false
otherwise
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |