update/org.eclipse.update.core/src/org/eclipse/update/core/IFeature.java - platform/eclipse.platform - Git at Google

 package org.eclipse.update.core;

 /*
  * (c) Copyright IBM Corp. 2000, 2002.
  * All Rights Reserved.
  */

 import java.net.URL;

 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;

  /**
   * Features define the packaging structure for a group
   * of related plug-ins, plug-in fragments, and optionally
   * non-plug-in files.
   *
   * <p>
   * Features are treated purely as an installation and packaging construct.
   * They do not play a role during Eclipse plug-in execution. Features do not nest.
   * 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.
   * </p>
   *
   */

 public interface IFeature {


 	/**
 	 * Returns the Identifier of this DefaultFeature.
 	 * The Identifier is not intended to be the key of the DefaultFeature.
 	 * the URL is the key of the feature.
 	 * @return the Identifier of this feature.
 	 * @see VersionedIdentifier
 	 * @since 2.0
 	 */

 	VersionedIdentifier getVersionedIdentifier();

 	/**
 	 * Returns the Site this DefaultFeature belongs to.
 	 * The site may be <code>null</code>.
 	 * @return the site of this feature
 	 * @since 2.0
 	 */

 	ISite getSite();

 	/**
 	 * Sets the Site this DefaultFeature belongs to.
 	 * @throws CoreException if the site is already set for this feature
 	 * @since 2.0
 	 */

 	void setSite(ISite site) throws CoreException;

 	/**
 	 * Returns the label of the feature.
 	 * The label is declared in the <code>feature.xml</code> file.
 	 * @return the label of the feature
 	 * @since 2.0
 	 */

 	String getLabel();

 	/**
 	 * Returns the URL that points at the DefaultFeature.
 	 * This URL is the unique identifier of the feature
 	 * within the site.
 	 *
 	 * The URL is declared in the <code>feature.xml</code> file.
 	 * The URL can be relative to the <codesite.xml</code> or absolute.
 	 * The DefaultFeature knows how to decipher the URL.
 	 *
 	 * @return the URL identifying feature in the Site.
 	 * @since 2.0
 	 */

 	URL getURL();

 	/**
 	 * Returns the Update Information about the DefaultFeature.
 	 * The URLEntry is usually a URL of a Site in which user
 	 * can find new version of the feature.
 	 *
 	 * The Update Information is composed of a URL and short label
 	 * for this URL.
 	 *
 	 * The URL is declared in the <code>feature.xml</code> file.
 	 *
 	 * @see IURLEntry
 	 * @return the IURLEntry that contains Update Information about this feature
 	 * @since 2.0
 	 */

 	IURLEntry getUpdateSiteEntry() ;

 	/**
 	 * Return an array of info where the user can find other features
 	 * related to this features.
 	 *
 	 * Each Discovery Information is composed of a URL and short label
 	 * for this URL.
 	 *
 	 * The URLs are declared in the <code>feature.xml</code> file.
 	 *
 	 * @see IURLEntry
 	 * @return a Array of discovery info.Returns an empty array
 	 * if there are no discovey info.
 	 * @since 2.0
 	 */

 	IURLEntry [] getDiscoverySiteEntries() ;

 	/**
 	 * Returns the provider of the feature
 	 * @return the provider of the feature
 	 * @since 2.0
 	 */

 	String getProvider() ;

 	/**
 	 * Returns the description of the DefaultFeature.
 	 * The description can be a short text and/or a
 	 * URL pointing to a file.
 	 *
 	 * The URL can be absolute or relative to the
 	 * <code> feature.xml. </code>
 	 *
 	 * The description is declared in the <code>feature.xml</code> file.
 	 *
 	 * @see IURLEntry
 	 * @return the description of this feature
 	 * @since 2.0
 	 */

 	IURLEntry getDescription() ;

 	/**
 	 * Returns the copyright of the DefaultFeature.
 	 * The copyright can be a short text and/or a
 	 * URL pointing to a file.
 	 *
 	 * The URL can be absolute or relative to the
 	 * <code> feature.xml. </code>
 	 *
 	 * The copyright is declared in the <code>feature.xml</code> file.
 	 *
 	 * @see IURLEntry
 	 * @return the copyright of this feature
 	 * @since 2.0
 	 */

 	IURLEntry getCopyright() ;

 	/**
 	 * Returns the license of the DefaultFeature.
 	 * The license can be a short text and/or a
 	 * URL pointing to a file.
 	 *
 	 * The URL can be absolute or relative to the
 	 * <code> feature.xml. </code>
 	 *
 	 * The license is declared in the <code>feature.xml</code> file.
 	 *
 	 * @see IURLEntry
 	 * @return the license of this feature
 	 * @since 2.0
 	 */

 	IURLEntry getLicense() ;

 	/**
 	 * Optional operating system specification.
 	 * A comma-separated list of os designators defined by Eclipse.
 	 * Indicates this feature should only be installed on one of the specified
 	 * os systems. If this attribute is not specified, the feature can be
 	 * installed on all systems (portable implementation).
 	 *
 	 * This information is used as a hint by the installation and update
 	 * support (user can force installation of feature regardless of this setting).
 	 *
 	 * @see org.eclipse.core.boot.BootLoader
 	 * @return the operating system specification.
 	 * @since 2.0
 	 */

 	String getOS()  ;

 	/**
 	 * Optional windowing system specification.
 	 * A comma-separated list of ws designators defined by Eclipse.
 	 *  Indicates this feature should only be installed on one of the specified
 	 *  ws systems. If this attribute is not specified, the feature can be
 	 *  installed on all systems (portable implementation).
 	 *
 	 * This information is used as a hint by the installation and update
 	 * support (user can force installation of feature regardless of this setting).
 	 *
 	 * @see org.eclipse.core.boot.BootLoader
 	 * @return the windowing system specification.
 	 * @since 2.0
 	 */

 	String getWS()  ;

 	/**
 	 * Optional locale specification.
 	 * A comma-separated list of locale designators defined by Java.
 	 * Indicates this feature should only be installed on a system running
 	 * with a compatible locale (using Java locale-matching rules).
 	 * If this attribute is not specified, the feature can be installed
 	 * on all systems (language-neutral implementation).
 	 *
 	 * This information is used as a hint by the installation and update
 	 *  support (user can force installation of feature regardless of this setting).
 	 *
 	 * @return the locale specification.
 	 * @since 2.0
 	 */

 	String getNL() ;

 	/**
 	 * optional image to use when displaying information about the feature.
 	 *
 	 * The URL is either absolute or relative to the <code>feature.xml</code> file.
 	 *
 	 * @return the URL pointing to the image
 	 * @since 2.0
 	 */

 	URL getImage() ;

 	/**
 	 * List of plugin the feature require
 	 * to be installed in the site before it
 	 * can be installed
 	 *
 	 * @return the list of required plug-ins. Returns an empty array
 	 * if there are no required.
 	 * @since 2.0
 	 */

 	IImport[] getImports();


 	/**
 	 * Install this feature into the targetFeature
 	 * @param targetFeature the feature to install into
 	 * @param verifier
 	 * @param monitor
 	 * @throws CoreException
 	 */
 	public IFeatureReference install(IFeature targetFeature,IVerificationListener verificationListener, IProgressMonitor monitor) throws CoreException;

 	/**
 	 * Returns an array of plug-ins managed by the Feature
 	 *
 	 * @return the accessible plug-ins. Returns an empty array
 	 * if there are no plug-ins.
 	 */

 	IPluginEntry [] getPluginEntries()  ;

 	/**
 	 * Returns the number of managed plug-ins
 	 * @return the number of plug-ins
 	 */

 	int getPluginEntryCount() ;

 	/**
 	 * Returns an array of archives identifier that compose the feature.
 	 *
 	 * @return
 	 * @since 2.0
 	 */
 	INonPluginEntry[] getNonPluginEntries();

 	/**
 	 * Returns the number of non plugin entries
 	 * @return the number of plug-ins
 	 */

 	int getNonPluginEntryCount() ;


 	/**
 	 * Download Size of the feature in Kilo-Bytes
 	 * @return the size of the archive to be downloaded
 	 * @since 2.0
 	 */

 	long getDownloadSize();

 	/**
 	 * Install Size of the feature in KiloBytes
 	 * @return the size of the plug-in when installed
 	 * @since 2.0
 	 */

 	long getInstallSize();

 	/**
 	 * optional identifier of the Eclipse application that is to be used during
      * startup when the declaring feature is the primary feature.
      *  The application identifier must represent a valid application registered
      *  in the <code>org.eclipse.core.runtime.applications</code> extension point.
      *  Default is <code>org.eclipse.ui.workbench</code>.
      * @since 2.0
 	 */

 	String getApplication();

 	/**
 	 * Sets the IFeatureContentProvider for this feature
 	 * @since 2.0
 	 */
 	void setFeatureContentProvider(IFeatureContentProvider featureContentProvider);

 	/**
 	 * Returns the IFeatureContentProvider for this feature
 	 * @throws CoreExcepton if the content provider is <code>null</code>
 	 * @since 2.0
 	 */
 	IFeatureContentProvider getFeatureContentProvider() throws CoreException;


 	/**
 	 *Returns the IFeatureContentConsumer for this feature
 	 * @throws CoreException when the DefaultFeature does not allow storage.
 	 * @since 2.0
 	 */
 	IFeatureContentConsumer getFeatureContentConsumer() throws CoreException;

 }
	package org.eclipse.update.core;

	/*
	* (c) Copyright IBM Corp. 2000, 2002.
	* All Rights Reserved.
	*/

	import java.net.URL;

	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IProgressMonitor;

	/**
	* Features define the packaging structure for a group
	* of related plug-ins, plug-in fragments, and optionally
	* non-plug-in files.
	*
	* <p>
	* Features are treated purely as an installation and packaging construct.
	* They do not play a role during Eclipse plug-in execution. Features do not nest.
	* 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.
	* </p>
	*
	*/

	public interface IFeature {


	/**
	* Returns the Identifier of this DefaultFeature.
	* The Identifier is not intended to be the key of the DefaultFeature.
	* the URL is the key of the feature.
	* @return the Identifier of this feature.
	* @see VersionedIdentifier
	* @since 2.0
	*/

	VersionedIdentifier getVersionedIdentifier();

	/**
	* Returns the Site this DefaultFeature belongs to.
	* The site may be <code>null</code>.
	* @return the site of this feature
	* @since 2.0
	*/

	ISite getSite();

	/**
	* Sets the Site this DefaultFeature belongs to.
	* @throws CoreException if the site is already set for this feature
	* @since 2.0
	*/

	void setSite(ISite site) throws CoreException;

	/**
	* Returns the label of the feature.
	* The label is declared in the <code>feature.xml</code> file.
	* @return the label of the feature
	* @since 2.0
	*/

	String getLabel();

	/**
	* Returns the URL that points at the DefaultFeature.
	* This URL is the unique identifier of the feature
	* within the site.
	*
	* The URL is declared in the <code>feature.xml</code> file.
	* The URL can be relative to the <codesite.xml</code> or absolute.
	* The DefaultFeature knows how to decipher the URL.
	*
	* @return the URL identifying feature in the Site.
	* @since 2.0
	*/

	URL getURL();

	/**
	* Returns the Update Information about the DefaultFeature.
	* The URLEntry is usually a URL of a Site in which user
	* can find new version of the feature.
	*
	* The Update Information is composed of a URL and short label
	* for this URL.
	*
	* The URL is declared in the <code>feature.xml</code> file.
	*
	* @see IURLEntry
	* @return the IURLEntry that contains Update Information about this feature
	* @since 2.0
	*/

	IURLEntry getUpdateSiteEntry() ;

	/**
	* Return an array of info where the user can find other features
	* related to this features.
	*
	* Each Discovery Information is composed of a URL and short label
	* for this URL.
	*
	* The URLs are declared in the <code>feature.xml</code> file.
	*
	* @see IURLEntry
	* @return a Array of discovery info.Returns an empty array
	* if there are no discovey info.
	* @since 2.0
	*/

	IURLEntry [] getDiscoverySiteEntries() ;

	/**
	* Returns the provider of the feature
	* @return the provider of the feature
	* @since 2.0
	*/

	String getProvider() ;

	/**
	* Returns the description of the DefaultFeature.
	* The description can be a short text and/or a
	* URL pointing to a file.
	*
	* The URL can be absolute or relative to the
	* <code> feature.xml. </code>
	*
	* The description is declared in the <code>feature.xml</code> file.
	*
	* @see IURLEntry
	* @return the description of this feature
	* @since 2.0
	*/

	IURLEntry getDescription() ;

	/**
	* Returns the copyright of the DefaultFeature.
	* The copyright can be a short text and/or a
	* URL pointing to a file.
	*
	* The URL can be absolute or relative to the
	* <code> feature.xml. </code>
	*
	* The copyright is declared in the <code>feature.xml</code> file.
	*
	* @see IURLEntry
	* @return the copyright of this feature
	* @since 2.0
	*/

	IURLEntry getCopyright() ;

	/**
	* Returns the license of the DefaultFeature.
	* The license can be a short text and/or a
	* URL pointing to a file.
	*
	* The URL can be absolute or relative to the
	* <code> feature.xml. </code>
	*
	* The license is declared in the <code>feature.xml</code> file.
	*
	* @see IURLEntry
	* @return the license of this feature
	* @since 2.0
	*/

	IURLEntry getLicense() ;

	/**
	* Optional operating system specification.
	* A comma-separated list of os designators defined by Eclipse.
	* Indicates this feature should only be installed on one of the specified
	* os systems. If this attribute is not specified, the feature can be
	* installed on all systems (portable implementation).
	*
	* This information is used as a hint by the installation and update
	* support (user can force installation of feature regardless of this setting).
	*
	* @see org.eclipse.core.boot.BootLoader
	* @return the operating system specification.
	* @since 2.0
	*/

	String getOS() ;

	/**
	* Optional windowing system specification.
	* A comma-separated list of ws designators defined by Eclipse.
	* Indicates this feature should only be installed on one of the specified
	* ws systems. If this attribute is not specified, the feature can be
	* installed on all systems (portable implementation).
	*
	* This information is used as a hint by the installation and update
	* support (user can force installation of feature regardless of this setting).
	*
	* @see org.eclipse.core.boot.BootLoader
	* @return the windowing system specification.
	* @since 2.0
	*/

	String getWS() ;

	/**
	* Optional locale specification.
	* A comma-separated list of locale designators defined by Java.
	* Indicates this feature should only be installed on a system running
	* with a compatible locale (using Java locale-matching rules).
	* If this attribute is not specified, the feature can be installed
	* on all systems (language-neutral implementation).
	*
	* This information is used as a hint by the installation and update
	* support (user can force installation of feature regardless of this setting).
	*
	* @return the locale specification.
	* @since 2.0
	*/

	String getNL() ;

	/**
	* optional image to use when displaying information about the feature.
	*
	* The URL is either absolute or relative to the <code>feature.xml</code> file.
	*
	* @return the URL pointing to the image
	* @since 2.0
	*/

	URL getImage() ;

	/**
	* List of plugin the feature require
	* to be installed in the site before it
	* can be installed
	*
	* @return the list of required plug-ins. Returns an empty array
	* if there are no required.
	* @since 2.0
	*/

	IImport[] getImports();



	/**
	* Install this feature into the targetFeature
	* @param targetFeature the feature to install into
	* @param verifier
	* @param monitor
	* @throws CoreException
	*/
	public IFeatureReference install(IFeature targetFeature,IVerificationListener verificationListener, IProgressMonitor monitor) throws CoreException;

	/**
	* Returns an array of plug-ins managed by the Feature
	*
	* @return the accessible plug-ins. Returns an empty array
	* if there are no plug-ins.
	*/

	IPluginEntry [] getPluginEntries() ;

	/**
	* Returns the number of managed plug-ins
	* @return the number of plug-ins
	*/

	int getPluginEntryCount() ;

	/**
	* Returns an array of archives identifier that compose the feature.
	*
	* @return
	* @since 2.0
	*/
	INonPluginEntry[] getNonPluginEntries();

	/**
	* Returns the number of non plugin entries
	* @return the number of plug-ins
	*/

	int getNonPluginEntryCount() ;


	/**
	* Download Size of the feature in Kilo-Bytes
	* @return the size of the archive to be downloaded
	* @since 2.0
	*/

	long getDownloadSize();

	/**
	* Install Size of the feature in KiloBytes
	* @return the size of the plug-in when installed
	* @since 2.0
	*/

	long getInstallSize();

	/**
	* optional identifier of the Eclipse application that is to be used during
	* startup when the declaring feature is the primary feature.
	* The application identifier must represent a valid application registered
	* in the <code>org.eclipse.core.runtime.applications</code> extension point.
	* Default is <code>org.eclipse.ui.workbench</code>.
	* @since 2.0
	*/

	String getApplication();

	/**
	* Sets the IFeatureContentProvider for this feature
	* @since 2.0
	*/
	void setFeatureContentProvider(IFeatureContentProvider featureContentProvider);

	/**
	* Returns the IFeatureContentProvider for this feature
	* @throws CoreExcepton if the content provider is <code>null</code>
	* @since 2.0
	*/
	IFeatureContentProvider getFeatureContentProvider() throws CoreException;


	/**
	*Returns the IFeatureContentConsumer for this feature
	* @throws CoreException when the DefaultFeature does not allow storage.
	* @since 2.0
	*/
	IFeatureContentConsumer getFeatureContentConsumer() throws CoreException;

	}