org.eclipse.update.core
Interface IFeature
-
All Superinterfaces:
-
IAdaptable,
IPlatformEnvironment
-
All Known Implementing Classes:
-
Feature
Deprecated. The org.eclipse.update component has been replaced by Equinox p2. This
provisional API was never promoted to stable API, and may be removed from a future release of the platform.
-
public interface IFeature
- extends
IAdaptable,
IPlatformEnvironment
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.
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.
-
Since:
- 2.0
-
See Also:
-
Feature
Field Summary
|
static int
|
SEARCH_LOCATION_BOTH
Deprecated. 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
Deprecated. Indicates the one-click update will search the
location of the nesting root feature. |
static int
|
SEARCH_LOCATION_FEATURE
Deprecated. Indicates the one-click update will search the
location defined by the feature. |
static int
|
STATUS_AMBIGUOUS
Deprecated. 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
Deprecated. Indicates a disable feature |
static int
|
STATUS_HAPPY
Deprecated. 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
Deprecated. 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
()
Deprecated. Returns an optional identifier of a co-location affinity feature. |
String
|
getApplication
()
Deprecated. Returns an optional identifier of an application to be used when
starting up the platform with this feature as the primary feature. |
IURLEntry
|
getCopyright
()
Deprecated. Returns the copyright information for the feature. |
IURLEntry
|
getDescription
()
Deprecated. Returns the feature description. |
IURLEntry[]
|
getDiscoverySiteEntries
()
Deprecated. Return an array of information entries referencing locations of other
update sites. |
long
|
getDownloadSize
()
Deprecated. Returns the download size of the feature, if it can be determined. |
IFeatureContentConsumer
|
getFeatureContentConsumer
()
Deprecated. Returns the content consumer for this feature. |
IFeatureContentProvider
|
getFeatureContentProvider
()
Deprecated. Returns the content provider for this feature. |
URL
|
getImage
()
Deprecated. Return optional image for the feature. |
IImport[]
|
getImports
()
Deprecated. Return a list of plug-in dependencies for this feature. |
IIncludedFeatureReference[]
|
getIncludedFeatureReferences
()
Deprecated. 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
()
Deprecated. Returns and optional custom install handler entry. |
long
|
getInstallSize
()
Deprecated. Returns the install size of the feature, if it can be determined. |
String
|
getLabel
()
Deprecated. Returns the displayable label of the feature. |
IURLEntry
|
getLicense
()
Deprecated. Returns the license information for the feature. |
INonPluginEntry[]
|
getNonPluginEntries
()
Deprecated. 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
()
Deprecated. Returns the count of referenced non-plug-in entries. |
IPluginEntry[]
|
getPluginEntries
()
Deprecated. 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
()
Deprecated. Returns the count of referenced plug-in entries. |
String
|
getPrimaryPluginID
()
Deprecated. Return the identifier of the primary plugin associated to this feature
or null if the feature is not a primary feature. |
String
|
getProvider
()
Deprecated. Returns a displayable label identifying the provider of this feature |
IImport[]
|
getRawImports
()
Deprecated. Return a list of plug-in dependencies for this feature. |
IIncludedFeatureReference[]
|
getRawIncludedFeatureReferences
()
Deprecated. Returns an array of feature references included by this feature
No filtering occurs |
INonPluginEntry[]
|
getRawNonPluginEntries
()
Deprecated. Returns an array of non-plug-in entries referenced by this feature
No filtering occurs |
IPluginEntry[]
|
getRawPluginEntries
()
Deprecated. Returns an array of plug-in entries referenced by this feature
No filtering occurs |
ISite
|
getSite
()
Deprecated. Returns the site this feature is associated with. |
IURLEntry
|
getUpdateSiteEntry
()
Deprecated. Returns an information entry referencing the location of the
feature update site. |
URL
|
getURL
()
Deprecated. Returns the feature URL. |
VersionedIdentifier
|
getVersionedIdentifier
()
Deprecated. Returns the feature identifier. |
IFeatureReference
|
install
(
IFeature targetFeature,
IFeatureReference[] optionalFeatures,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Deprecated. Install the contents of this feature into the specified target feature. |
IFeatureReference
|
install
(
IFeature targetFeature,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Deprecated. Install the contents of this feature into the specified target feature. |
boolean
|
isExclusive
()
Deprecated. Indicates whether the feature must be processed alone during installation
and configuration. |
boolean
|
isPatch
()
Deprecated. Returns true if this feature is patching another feature,
false otherwise |
boolean
|
isPrimary
()
Deprecated. Indicates whether the feature can be used as a primary feature. |
void
|
setFeatureContentProvider
(
IFeatureContentProvider featureContentProvider)
Deprecated. Sets the content provider for this feature. |
void
|
setSite
(
ISite site)
Deprecated. Sets the site for this feature. |
STATUS_HAPPY
static final int STATUS_HAPPY
-
Deprecated.
- 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.
-
Since:
- 2.0
-
See Also:
-
IConfiguredSite.getBrokenStatus(IFeature)
,
Constant Field Values
STATUS_AMBIGUOUS
static final int STATUS_AMBIGUOUS
-
Deprecated.
- 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.
-
See Also:
-
IConfiguredSite.getBrokenStatus(IFeature)
,
Constant Field Values
STATUS_UNHAPPY
static final int STATUS_UNHAPPY
-
Deprecated.
- 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.
-
Since:
- 2.0
-
See Also:
-
IConfiguredSite.getBrokenStatus(IFeature)
,
Constant Field Values
STATUS_DISABLED
static final int STATUS_DISABLED
-
Deprecated.
- Indicates a disable feature
-
Since:
- 2.0.2
-
See Also:
-
IConfiguredSite.getBrokenStatus(IFeature)
,
Constant Field Values
SEARCH_LOCATION_DEFAULT
static final int SEARCH_LOCATION_DEFAULT
-
Deprecated.
- Indicates the one-click update will search the
location of the nesting root feature.
-
Since:
- 2.0.1
-
See Also:
-
Constant Field Values
SEARCH_LOCATION_FEATURE
static final int SEARCH_LOCATION_FEATURE
-
Deprecated.
- Indicates the one-click update will search the
location defined by the feature.
-
Since:
- 2.0.1
-
See Also:
-
Constant Field Values
SEARCH_LOCATION_BOTH
static final int SEARCH_LOCATION_BOTH
-
Deprecated.
- Indicates the one-click update will search both the
location of the nesting root feature and the
location defined by the feature.
-
Since:
- 2.0.1
-
See Also:
-
Constant Field Values
getVersionedIdentifier
VersionedIdentifier getVersionedIdentifier()
-
Deprecated.
- Returns the feature identifier.
-
-
-
Returns:
- the feature identifier.
-
Since:
- 2.0
getSite
ISite getSite()
-
Deprecated.
- Returns the site this feature is associated with.
-
-
-
Returns:
- the site for this feature
-
Since:
- 2.0
getLabel
String getLabel()
-
Deprecated.
- Returns the displayable label of the feature.
-
-
-
Returns:
- feature label, or
null
. -
Since:
- 2.0
getURL
URL getURL()
-
Deprecated.
- Returns the feature URL.
This is the URL that was used to create the feature. The interpretation
of the URL is dependent on the concrete feature implementation. *
-
-
-
Returns:
- feature URL
-
Since:
- 2.0
getUpdateSiteEntry
IURLEntry getUpdateSiteEntry()
-
Deprecated.
- Returns an information entry referencing the location of the
feature update site. The update site can be accessed to obtain
feature updates for this feature.
-
-
-
Returns:
- update site entry, or
null
. -
Since:
- 2.0
getDiscoverySiteEntries
IURLEntry[] getDiscoverySiteEntries()
-
Deprecated.
- Return an array of information entries referencing locations of other
update sites. This mechanism can be used by features to distribute
location information about general update sites to clients.
-
-
-
Returns:
- an array of site entries, or an empty array.
-
Since:
- 2.0
getProvider
String getProvider()
-
Deprecated.
- Returns a displayable label identifying the provider of this feature
-
-
-
Returns:
- provider label, or
null
. -
Since:
- 2.0
getInstallHandlerEntry
IInstallHandlerEntry getInstallHandlerEntry()
-
Deprecated.
- Returns and optional custom install handler entry.
-
-
-
Returns:
- install handler entry, or
null
if
none was specified -
Since:
- 2.0
getDescription
IURLEntry getDescription()
-
Deprecated.
- Returns the feature description.
-
-
-
Returns:
- feature description, or
null
. -
Since:
- 2.0
getCopyright
IURLEntry getCopyright()
-
Deprecated.
- Returns the copyright information for the feature.
-
-
-
Returns:
- copyright information, or
null
. -
Since:
- 2.0
getLicense
IURLEntry getLicense()
-
Deprecated.
- Returns the license information for the feature.
-
-
-
Returns:
- feature license, or
null
. -
Since:
- 2.0
getImage
URL getImage()
-
Deprecated.
- Return optional image for the feature.
-
-
-
Returns:
- the URL pointing to the image, , or
null
. -
Since:
- 2.0
getImports
IImport[] getImports()
-
Deprecated.
- Return a list of plug-in dependencies for this feature. A plug-in
dependency is a reference to a plug-in required for feature execution
that is not packaged as part of the feature.
filtered by the operating system, windowing system and architecture system
set in
SiteManager
-
-
-
Returns:
- the list of required plug-in dependencies, or an empty array.
-
Since:
- 2.0
getRawImports
IImport[] getRawImports()
-
Deprecated.
- Return a list of plug-in dependencies for this feature. A plug-in
dependency is a reference to a plug-in required for feature execution
that is not packaged as part of the feature.
No filtering occurs
-
-
-
Returns:
- the list of required plug-in dependencies, or an empty array.
-
Since:
- 2.1
getPrimaryPluginID
String getPrimaryPluginID()
-
Deprecated.
- Return the identifier of the primary plugin associated to this feature
or
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.
-
-
-
Returns:
- the identifier of the associated primary plugin or
null
-
Since:
- 2.1
install
IFeatureReference install(
IFeature targetFeature,
IVerificationListener verificationListener,
IProgressMonitor monitor)
throws
InstallAbortedException,
CoreException
-
Deprecated.
- Install the contents of this feature into the specified target feature.
All optional features will be installed
-
-
-
Parameters:
-
targetFeature
- -
verificationListener
- -
monitor
-
-
Throws:
-
InstallAbortedException
- when the user cancels the install
-
CoreException
-
Since:
- 2.0
install
IFeatureReference install(
IFeature targetFeature,
IFeatureReference[] optionalFeatures,
IVerificationListener verificationListener,
IProgressMonitor monitor)
throws
InstallAbortedException,
CoreException
-
Deprecated.
- Install the contents of this feature into the specified target feature.
Only the listed optional features will be installed.
-
-
-
Parameters:
-
targetFeature
- -
optionalFeatures
- the optional features to be installed -
verificationListener
- -
monitor
-
-
Throws:
-
InstallAbortedException
- when the user cancels the install
-
CoreException
-
Since:
- 2.0.1
getIncludedFeatureReferences
IIncludedFeatureReference[] getIncludedFeatureReferences()
throws
CoreException
-
Deprecated.
- Returns an array of feature references included by this feature
filtered by the operating system, windowing system and architecture system
set in
SiteManager
-
-
-
Returns:
- an array of feature references, or an empty array.
-
Throws:
-
CoreException
-
Since:
- 2.0
getRawIncludedFeatureReferences
IIncludedFeatureReference[] getRawIncludedFeatureReferences()
throws
CoreException
-
Deprecated.
- Returns an array of feature references included by this feature
No filtering occurs
-
-
-
Returns:
- an array of feature references, or an empty array.
-
Throws:
-
CoreException
-
Since:
- 2.0
getPluginEntries
IPluginEntry[] getPluginEntries()
-
Deprecated.
- Returns an array of plug-in entries referenced by this feature
filtered by the operating system, windowing system and architecture system
set in
SiteManager
-
-
-
Returns:
- an array of plug-in entries, or an empty array.
-
Since:
- 2.0
getRawPluginEntries
IPluginEntry[] getRawPluginEntries()
-
Deprecated.
- Returns an array of plug-in entries referenced by this feature
No filtering occurs
-
-
-
Returns:
- an array of plug-in entries, or an empty array.
-
Since:
- 2.1
getPluginEntryCount
int getPluginEntryCount()
-
Deprecated.
- Returns the count of referenced plug-in entries.
-
-
-
Returns:
- plug-in entry count
-
Since:
- 2.0
getNonPluginEntries
INonPluginEntry[] getNonPluginEntries()
-
Deprecated.
- 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
-
-
-
Returns:
- an array of non-plug-in entries, or an empty array.
-
Since:
- 2.0
getRawNonPluginEntries
INonPluginEntry[] getRawNonPluginEntries()
-
Deprecated.
- Returns an array of non-plug-in entries referenced by this feature
No filtering occurs
-
-
-
Returns:
- an array of non-plug-in entries, or an empty array.
-
Since:
- 2.1
getNonPluginEntryCount
int getNonPluginEntryCount()
-
Deprecated.
- Returns the count of referenced non-plug-in entries.
-
-
-
Returns:
- non-plug-in entry count
-
Since:
- 2.0
getDownloadSize
long getDownloadSize()
-
Deprecated.
- Returns the download size of the feature, if it can be determined.
-
-
-
Returns:
- download size of the feature in KiloBytes, or an indication
the size could not be determined
-
Since:
- 2.0
-
See Also:
-
ContentEntryModel.UNKNOWN_SIZE
getInstallSize
long getInstallSize()
-
Deprecated.
- Returns the install size of the feature, if it can be determined.
-
-
-
Returns:
- install size of the feature in KiloBytes, or an indication
the size could not be determined
-
Since:
- 2.0
-
See Also:
-
ContentEntryModel.UNKNOWN_SIZE
isPrimary
boolean isPrimary()
-
Deprecated.
- Indicates whether the feature can be used as a primary feature.
-
-
-
Returns:
-
true
if this is a primary feature,
otherwise false
-
Since:
- 2.0
isExclusive
boolean isExclusive()
-
Deprecated.
- Indicates whether the feature must be processed alone during installation
and configuration. Features that are not exclusive can be installed in a
batch.
-
-
-
Returns:
-
true
if feature requires exclusive processing,
false
otherwise. -
Since:
- 2.1
getApplication
String getApplication()
-
Deprecated.
- Returns an optional identifier of an application to be used when
starting up the platform with this feature as the primary feature.
The application identifier must represent a valid application registered
in the
org.eclipse.core.runtime.applications
extension point.
-
-
-
Returns:
- application identifier, or
null
-
Since:
- 2.0
getAffinityFeature
String getAffinityFeature()
-
Deprecated.
- Returns an optional identifier of a co-location affinity feature.
-
-
-
Returns:
- feature identifier, or
null
. -
Since:
- 2.0
getFeatureContentProvider
IFeatureContentProvider getFeatureContentProvider()
throws
CoreException
-
Deprecated.
- Returns the content provider for this feature. A content provider
is an abstraction of each feature internal packaging structure.
It allows the feature content to be accessed in a standard way
regardless of the internal packaging. All concrete features
need to be able to return a content provider.
-
-
-
Returns:
- feature content provider
-
Throws:
-
CoreException
-
Since:
- 2.0
getFeatureContentConsumer
IFeatureContentConsumer getFeatureContentConsumer()
throws
CoreException
-
Deprecated.
- Returns the content consumer for this feature. A content consumer
is an abstraction of each feature internal packaging mechanism.
It allows content to be stored into a feature in a standard way
regardless of the packaging mechanism used. Only concrete features
that support storing need to implement a content consumer. The platform
implements at least one feature type supporting content consumer.
This is the feature type representing a locally-installed
feature.
-
-
-
Returns:
- feature content consumer
-
Throws:
-
CoreException
-
UnsupportedOperationException
-
Since:
- 2.0
setSite
void setSite(
ISite site)
throws
CoreException
-
Deprecated.
- Sets the site for this feature. This is typically performed as part
of the feature creation operation. Once set, the site
should not be reset.
-
-
-
Parameters:
-
site
- the site
-
Throws:
-
CoreException
- site for this feature is already set -
Since:
- 2.0
setFeatureContentProvider
void setFeatureContentProvider(
IFeatureContentProvider featureContentProvider)
-
Deprecated.
- Sets the content provider for this feature. This is typically
performed as part of the feature creation operation. Once set, the
provider should not be reset.
-
-
-
Parameters:
-
featureContentProvider
- content provider -
Since:
- 2.0
isPatch
boolean isPatch()
-
Deprecated.
- Returns
true
if this feature is patching another feature,
false
otherwise
-
-
-
Returns:
- boolean
-
Since:
- 2.1
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.