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
Interface IFeatureContentConsumer


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 IFeatureContentConsumer

Feature content consumer. A feature 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.

A feature content consumer delegates the storage of plug-in and non-plug-in files to a generic content consumer.

Clients may implement this interface. However, in most cases clients will only use the feature content consumer provided by the feature type(s) implemented by the platform.

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:
IContentConsumer

Method Summary
 void abort ()
          Deprecated. Closes this content consumer, indicating the store operations should be aborted.
 void addChild ( IFeature feature)
          Deprecated. Link the content consumer of the feature as a child content consumer
  IFeatureReference close ()
          Deprecated. Closes this content consumer.
  IFeatureContentConsumer[] getChildren ()
          Deprecated. Returns the feature content consumers that this feature content consumer opened
  IFeature getFeature ()
          Deprecated. Returns the feature for this content consumer.
  IFeatureContentConsumer getParent ()
          Deprecated. Returns the feature content consumer that opened this feature content consumer, or null if this feature content consumer is a root feature content consumer.
  IContentConsumer open ( INonPluginEntry nonPluginEntry)
          Deprecated. Opens a generic content consumer for the specified non-plug-in entry.
  IContentConsumer open ( IPluginEntry pluginEntry)
          Deprecated. Opens a generic content consumer for the specified plug-in entry.
 void setFeature ( IFeature feature)
          Deprecated. Sets the feature for this content consumer.
 void setParent ( IFeatureContentConsumer parent)
          Deprecated. Sets the parent for this content consumer.
 void store ( ContentReference contentReference, IProgressMonitor monitor)
          Deprecated. Store a feature file.
 

Method Detail

store

void store(
ContentReference contentReference,
           
IProgressMonitor monitor)
           throws 
CoreException
Deprecated. 
Store a feature file. Note that only the feature definition files should be stored using this method. Plug-in files and non-plug-in data files should be stored using the content consumers corresponding to their respective entries.

Parameters:
contentReference - content reference to feature file
monitor - progress monitor, can be null
Throws:
CoreException
Since:
2.0
See Also:
open(IPluginEntry), open(INonPluginEntry)

open

IContentConsumer open(
IPluginEntry pluginEntry)
                      throws 
CoreException
Deprecated. 
Opens a generic content consumer for the specified plug-in entry. Plug-in files corresponding to this entry should be stored using this content consumer.

Parameters:
pluginEntry - plug-in entry
Returns:
generic content consumer for the entry
Throws:
CoreException
Since:
2.0

open

IContentConsumer open(
INonPluginEntry nonPluginEntry)
                      throws 
CoreException
Deprecated. 
Opens a generic content consumer for the specified non-plug-in entry. Non-plug-in files corresponding to this entry should be stored using this content consumer.

Parameters:
nonPluginEntry - non-plug-in entry
Returns:
generic content consumer for the entry
Throws:
CoreException
Since:
2.0

close

IFeatureReference close()
                        throws 
CoreException
Deprecated. 
Closes this content consumer. This indicates a successful completion of the store operations. The content consumer commits any changes made by this consumer.

Returns:
reference to the newly populated feature
Throws:
CoreException
Since:
2.0

abort

void abort()
           throws 
CoreException
Deprecated. 
Closes this content consumer, indicating the store operations should be aborted. The content consumer attempts to back out any changes made by this content consumer.

Throws:
CoreException
Since:
2.0

setFeature

void setFeature(
IFeature feature)
Deprecated. 
Sets the feature for this content consumer. In general, this method should only be called as part of feature creation. Once set, the feature should not be reset.

Parameters:
feature - feature for this content consumer
Since:
2.0

getFeature

IFeature getFeature()
Deprecated. 
Returns the feature for this content consumer.

Returns:
the feature for this content consumer
Since:
2.0

setParent

void setParent(
IFeatureContentConsumer parent)
Deprecated. 
Sets the parent for this content consumer. In general, this method should only be called as part of feature creation. Once set, the feature should not be reset.

Parameters:
parent - parent feature content consumer.
Since:
2.0

getParent

IFeatureContentConsumer getParent()
Deprecated. 
Returns the feature content consumer that opened this feature content consumer, or null if this feature content consumer is a root feature content consumer.

Returns:
the parent feature content consumer, or null.
Since:
2.0

addChild

void addChild(
IFeature feature)
              throws 
CoreException
Deprecated. 
Link the content consumer of the feature as a child content consumer

Parameters:
feature - the child feature.
Throws:
CoreException
Since:
2.0

getChildren

IFeatureContentConsumer[] getChildren()
Deprecated. 
Returns the feature content consumers that this feature content consumer opened

Returns:
an array of feature content consumer, or en empty array.
Since:
2.0

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