Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.update.core
Class Feature

java.lang.Object
  extended by 

org.eclipse.core.runtime.PlatformObject
      extended by 

org.eclipse.update.core.model.ModelObject
          extended by 

org.eclipse.update.core.model.FeatureModel
              extended by 
org.eclipse.update.core.Feature
All Implemented Interfaces:
IAdaptable, IFeature, IPlatformEnvironment

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 class Feature
extends FeatureModel
implements IFeature

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.

Since:
2.0
See Also:
IFeature, FeatureModel

Field Summary
static  String FEATURE_FILE
          Deprecated. Simple file name of the default feature manifest file
static  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 ( 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.
  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.
  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.
  String toString ()
          Deprecated. Return the string representation of this fetaure
 
Methods inherited from class org.eclipse.update.core.model. FeatureModel
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
 
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
 
Methods inherited from interface org.eclipse.core.runtime. IAdaptable
getAdapter
 

Field Detail

FEATURE_FILE

public static final 
String FEATURE_FILE
Deprecated. 
Simple file name of the default feature manifest file

Since:
2.0
See Also:
Constant Field Values

FEATURE_XML

public static final 
String FEATURE_XML
Deprecated. 
File extension of the default feature manifest file

Since:
2.0
See Also:
Constant Field Values
Constructor Detail

Feature

public Feature()
Deprecated. 
Feature default constructor

Since:
2.0
Method Detail

equals

public boolean equals(
Object object)
Deprecated. 
Compares two features for equality

Overrides:
equals in class FeatureModel
Parameters:
object - feature object to compare with
Returns:
true if the two features are equal, false otherwise
Since:
2.0

getVersionedIdentifier

public 
VersionedIdentifier getVersionedIdentifier()
Deprecated. 
Returns the feature identifier.

Specified by:
getVersionedIdentifier in interface IFeature
Returns:
the feature identifier.
Since:
2.0
See Also:
IFeature.getVersionedIdentifier()

getSite

public 
ISite getSite()
Deprecated. 
Returns the site this feature is associated with.

Specified by:
getSite in interface IFeature
Returns:
the site for this feature
Since:
2.0
See Also:
IFeature.getSite()

getURL

public 
URL getURL()
Deprecated. 
Returns the feature URL.

Specified by:
getURL in interface IFeature
Returns:
feature URL
Since:
2.0
See Also:
IFeature.getURL()

getUpdateSiteEntry

public 
IURLEntry getUpdateSiteEntry()
Deprecated. 
Returns an information entry referencing the location of the feature update site.

Specified by:
getUpdateSiteEntry in interface IFeature
Returns:
update site entry, or null.
Since:
2.0
See Also:
IFeature.getUpdateSiteEntry()

getDiscoverySiteEntries

public 
IURLEntry[] getDiscoverySiteEntries()
Deprecated. 
Return an array of information entries referencing locations of other update sites.

Specified by:
getDiscoverySiteEntries in interface IFeature
Returns:
an array of site entries, or an empty array.
Since:
2.0
See Also:
IFeature.getDiscoverySiteEntries()

getInstallHandlerEntry

public 
IInstallHandlerEntry getInstallHandlerEntry()
Deprecated. 
Returns and optional custom install handler entry.

Specified by:
getInstallHandlerEntry in interface IFeature
Returns:
install handler entry, or null if none was specified
Since:
2.0
See Also:
IFeature.getInstallHandlerEntry()

getDescription

public 
IURLEntry getDescription()
Deprecated. 
Returns the feature description.

Specified by:
getDescription in interface IFeature
Returns:
feature description, or null.
Since:
2.0
See Also:
IFeature.getDescription()

getCopyright

public 
IURLEntry getCopyright()
Deprecated. 
Returns the copyright information for the feature.

Specified by:
getCopyright in interface IFeature
Returns:
copyright information, or null.
Since:
2.0
See Also:
IFeature.getCopyright()

getLicense

public 
IURLEntry getLicense()
Deprecated. 
Returns the license information for the feature.

Specified by:
getLicense in interface IFeature
Returns:
feature license, or null.
Since:
2.0
See Also:
IFeature.getLicense()

getImage

public 
URL getImage()
Deprecated. 
Return optional image for the feature.

Specified by:
getImage in interface IFeature
Returns:
the URL pointing to the image, , or null.
Since:
2.0
See Also:
IFeature.getImage()

getRawImports

public 
IImport[] getRawImports()
Deprecated. 
Return a list of plug-in dependencies for this feature.

Specified by:
getRawImports in interface IFeature
Returns:
the list of required plug-in dependencies, or an empty array.
Since:
2.0
See Also:
IFeature.getRawImports()

install

public 
IFeatureReference install(
IFeature targetFeature,
                                 
IVerificationListener verificationListener,
                                 
IProgressMonitor progress)
                          throws 
InstallAbortedException,
                                 
CoreException
Deprecated. 
Install the contents of this feature into the specified target feature. This method is a reference implementation of the feature installation protocol. Other concrete feature implementation that override this method need to implement this protocol.

Specified by:
install in interface IFeature
Throws:
InstallAbortedException - when the user cancels the install
CoreException
Since:
2.0
See Also:
IFeature.install(IFeature, IVerificationListener, IProgressMonitor)

install

public 
IFeatureReference install(
IFeature targetFeature,
                                 
IFeatureReference[] optionalfeatures,
                                 
IVerificationListener verificationListener,
                                 
IProgressMonitor progress)
                          throws 
InstallAbortedException,
                                 
CoreException
Deprecated. 
Install the contents of this feature into the specified target feature. This method is a reference implementation of the feature installation protocol. Other concrete feature implementation that override this method need to implement this protocol.

Specified by:
install in interface IFeature
optionalfeatures - the optional features to be installed
Throws:
InstallAbortedException - when the user cancels the install
CoreException
Since:
2.0
See Also:
IFeature.install(IFeature, IVerificationListener, IProgressMonitor)

getRawPluginEntries

public 
IPluginEntry[] getRawPluginEntries()
Deprecated. 
Returns an array of plug-in entries referenced by this feature

Specified by:
getRawPluginEntries in interface IFeature
Returns:
an array of plug-in entries, or an empty array.
Since:
2.0
See Also:
IFeature.getPluginEntries()

getPluginEntryCount

public int getPluginEntryCount()
Deprecated. 
Returns the count of referenced plug-in entries.

Specified by:
getPluginEntryCount in interface IFeature
Returns:
plug-in entry count
Since:
2.0
See Also:
IFeature.getPluginEntryCount()

getRawNonPluginEntries

public 
INonPluginEntry[] getRawNonPluginEntries()
Deprecated. 
Returns an array of non-plug-in entries referenced by this feature

Specified by:
getRawNonPluginEntries in interface IFeature
Returns:
an array of non-plug-in entries, or an empty array.
Since:
2.0
See Also:
IFeature.getNonPluginEntries()

getNonPluginEntryCount

public int getNonPluginEntryCount()
Deprecated. 
Returns the count of referenced non-plug-in entries.

Specified by:
getNonPluginEntryCount in interface IFeature
Returns:
non-plug-in entry count
Since:
2.0
See Also:
IFeature.getNonPluginEntryCount()

getRawIncludedFeatureReferences

public 
IIncludedFeatureReference[] getRawIncludedFeatureReferences()
                                                            throws 
CoreException
Deprecated. 
Returns an array of feature references included by this feature

Specified by:
getRawIncludedFeatureReferences in interface IFeature
Returns:
an erray of feature references, or an empty array.
Throws:
CoreException
Since:
2.0

getDownloadSize

public long getDownloadSize()
Deprecated. 
Returns the download size of the feature, if it can be determined.

Specified by:
getDownloadSize in interface IFeature
Returns:
download size of the feature in KiloBytes, or an indication the size could not be determined
Since:
2.0
See Also:
IFeature.getDownloadSize()

getInstallSize

public long getInstallSize()
Deprecated. 
Returns the install size of the feature, if it can be determined.

Specified by:
getInstallSize in interface IFeature
Returns:
install size of the feature in KiloBytes, or an indication the size could not be determined
Since:
2.0
See Also:
IFeature.getInstallSize()

getFeatureContentProvider

public 
IFeatureContentProvider getFeatureContentProvider()
                                                  throws 
CoreException
Deprecated. 
Returns the content provider for this feature.

Specified by:
getFeatureContentProvider in interface IFeature
Returns:
feature content provider
Throws:
CoreException
Since:
2.0
See Also:
IFeature.getFeatureContentProvider()

getFeatureContentConsumer

public 
IFeatureContentConsumer getFeatureContentConsumer()
                                                  throws 
CoreException
Deprecated. 
Returns the content consumer for this feature.

Specified by:
getFeatureContentConsumer in interface IFeature
Returns:
feature content consumer
Throws:
CoreException
Since:
2.0
See Also:
IFeature.getFeatureContentConsumer()

setSite

public void setSite(
ISite site)
             throws 
CoreException
Deprecated. 
Sets the site for this feature.

Specified by:
setSite in interface IFeature
Parameters:
site - the site
Throws:
CoreException - site for this feature is already set
Since:
2.0
See Also:
IFeature.setSite(ISite)

setFeatureContentProvider

public void setFeatureContentProvider(
IFeatureContentProvider featureContentProvider)
Deprecated. 
Sets the content provider for this feature.

Specified by:
setFeatureContentProvider in interface IFeature
Parameters:
featureContentProvider - content provider
Since:
2.0
See Also:
IFeature.setFeatureContentProvider(IFeatureContentProvider)

toString

public 
String toString()
Deprecated. 
Return the string representation of this fetaure

Overrides:
toString in class Object
Returns:
feature as string
Since:
2.0

getIncludedFeatureReferences

public 
IIncludedFeatureReference[] getIncludedFeatureReferences()
                                                         throws 
CoreException
Deprecated. 
Description copied from interface: IFeature
Returns an array of feature references included by this feature filtered by the operating system, windowing system and architecture system set in SiteManager

Specified by:
getIncludedFeatureReferences in interface IFeature
Returns:
an array of feature references, or an empty array.
Throws:
CoreException
See Also:
IFeature.getRawIncludedFeatureReferences()

getNonPluginEntries

public 
INonPluginEntry[] getNonPluginEntries()
Deprecated. 
Description copied from interface: IFeature
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

Specified by:
getNonPluginEntries in interface IFeature
Returns:
an array of non-plug-in entries, or an empty array.
See Also:
IFeature.getRawNonPluginEntries()

getPluginEntries

public 
IPluginEntry[] getPluginEntries()
Deprecated. 
Description copied from interface: IFeature
Returns an array of plug-in entries referenced by this feature filtered by the operating system, windowing system and architecture system set in SiteManager

Specified by:
getPluginEntries in interface IFeature
Returns:
an array of plug-in entries, or an empty array.
See Also:
IFeature.getRawPluginEntries()

getImports

public 
IImport[] getImports()
Deprecated. 
Description copied from interface: IFeature
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

Specified by:
getImports in interface IFeature
Returns:
the list of required plug-in dependencies, or an empty array.
See Also:
IFeature.getImports()

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire