|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.update.core.model.ModelObject
org.eclipse.update.core.model.FeatureModel
org.eclipse.update.core.Feature
public class Feature
Convenience implementation of a feature.
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| Field Summary | |
|---|---|
static java.lang.String |
FEATURE_FILE
Deprecated. Simple file name of the default feature manifest file |
static java.lang.String |
FEATURE_XML
Deprecated. File extension of the default feature manifest file |
| Fields inherited from interface org.eclipse.update.core.IFeature |
|---|
SEARCH_LOCATION_BOTH, SEARCH_LOCATION_DEFAULT, SEARCH_LOCATION_FEATURE, STATUS_AMBIGUOUS, STATUS_DISABLED, STATUS_HAPPY, STATUS_UNHAPPY |
| Constructor Summary | |
|---|---|
Feature()
Deprecated. Feature default constructor |
|
| Method Summary | |
|---|---|
boolean |
equals(java.lang.Object object)
Deprecated. Compares two features for equality |
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. |
java.net.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. |
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. |
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 |
INonPluginEntry[] |
getRawNonPluginEntries()
Deprecated. Returns an array of non-plug-in entries referenced by this feature |
IPluginEntry[] |
getRawPluginEntries()
Deprecated. Returns an array of plug-in entries referenced by this feature |
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. |
java.net.URL |
getURL()
Deprecated. Returns the feature URL. |
VersionedIdentifier |
getVersionedIdentifier()
Deprecated. Returns the feature identifier. |
IFeatureReference |
install(IFeature targetFeature,
IFeatureReference[] optionalfeatures,
IVerificationListener verificationListener,
IProgressMonitor progress)
Deprecated. Install the contents of this feature into the specified target feature. |
IFeatureReference |
install(IFeature targetFeature,
IVerificationListener verificationListener,
IProgressMonitor progress)
Deprecated. Install the contents of this feature into the specified target feature. |
void |
setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
Deprecated. Sets the content provider for this feature. |
void |
setSite(ISite site)
Deprecated. Sets the site for this feature. |
java.lang.String |
toString()
Deprecated. Return the string representation of this fetaure |
| Methods inherited from class org.eclipse.update.core.model.ModelObject |
|---|
arrayTypeFor, arrayTypeFor, assertIsWriteable, getPropertyName, getResourceBundle, isReadOnly, markListReferenceReadOnly, markReferenceReadOnly, resolveListReference, resolveNLString, resolveReference, resolveURL |
| Methods inherited from class org.eclipse.core.runtime.PlatformObject |
|---|
getAdapter |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.update.core.IFeature |
|---|
getAffinityFeature, getApplication, getLabel, getPrimaryPluginID, getProvider, isExclusive, isPatch, isPrimary |
| Methods inherited from interface org.eclipse.update.core.IPlatformEnvironment |
|---|
getNL, getOS, getOSArch, getWS |
| Field Detail |
|---|
public static final java.lang.String FEATURE_FILE
public static final java.lang.String FEATURE_XML
| Constructor Detail |
|---|
public Feature()
| Method Detail |
|---|
public boolean equals(java.lang.Object object)
equals in class FeatureModelobject - feature object to compare with
true if the two features are equal,
false otherwisepublic VersionedIdentifier getVersionedIdentifier()
getVersionedIdentifier in interface IFeatureIFeature.getVersionedIdentifier()public ISite getSite()
getSite in interface IFeatureIFeature.getSite()public java.net.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 java.net.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 install
CoreExceptionIFeature.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 installed
InstallAbortedException - when the user cancels the install
CoreExceptionIFeature.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 site
CoreException - site for this feature is already setIFeature.setSite(ISite)public void setFeatureContentProvider(IFeatureContentProvider featureContentProvider)
setFeatureContentProvider in interface IFeaturefeatureContentProvider - content providerIFeature.setFeatureContentProvider(IFeatureContentProvider)public java.lang.String toString()
toString in class java.lang.Object
public IIncludedFeatureReference[] getIncludedFeatureReferences()
throws CoreException
IFeatureSiteManager
getIncludedFeatureReferences in interface IFeatureCoreExceptionIFeature.getRawIncludedFeatureReferences()public INonPluginEntry[] getNonPluginEntries()
IFeatureSiteManager
getNonPluginEntries in interface IFeatureIFeature.getRawNonPluginEntries()public IPluginEntry[] getPluginEntries()
IFeatureSiteManager
getPluginEntries in interface IFeatureIFeature.getRawPluginEntries()public IImport[] getImports()
IFeatureSiteManager
getImports in interface IFeatureIFeature.getImports()
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.