|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
IContentConsumer
Method Summary | |
void |
abort()
Closes this content consumer, indicating the store operations should be aborted. |
void |
addChild(IFeature feature)
Link the content consumer of the feature as a child content consumer |
IFeatureReference |
close()
Closes this content consumer. |
IFeatureContentConsumer[] |
getChildren()
Returns the feature content consumers that this feature content consumer opened |
IFeature |
getFeature()
Returns the feature for this content consumer. |
IFeatureContentConsumer |
getParent()
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)
Opens a generic content consumer for the specified non-plug-in entry. |
IContentConsumer |
open(IPluginEntry pluginEntry)
Opens a generic content consumer for the specified plug-in entry. |
void |
setFeature(IFeature feature)
Sets the feature for this content consumer. |
void |
setParent(IFeatureContentConsumer parent)
Sets the parent for this content consumer. |
void |
store(ContentReference contentReference,
IProgressMonitor monitor)
Store a feature file. |
Method Detail |
public void store(ContentReference contentReference, IProgressMonitor monitor) throws CoreException
ContentReference
- content reference to feature fileIProgressMonitor
- progress monitor, can be null
CoreException
- open(IPluginEntry)
,
open(INonPluginEntry)
public IContentConsumer open(IPluginEntry pluginEntry) throws CoreException
nonPluginEntry
- non-plug-in entryCoreException
- public IContentConsumer open(INonPluginEntry nonPluginEntry) throws CoreException
nonPluginEntry
- non-plug-in entryCoreException
- public IFeatureReference close() throws CoreException
CoreException
- public void abort() throws CoreException
CoreException
- public void setFeature(IFeature feature)
feature
- feature for this content consumerpublic IFeature getFeature()
public void setParent(IFeatureContentConsumer parent)
parent
- parent feature content consumer.public IFeatureContentConsumer getParent()
null
if this feature content consumer is a root feature
content consumer.public void addChild(IFeature feature) throws CoreException
feature
- the child feature.CoreException
- public IFeatureContentConsumer[] getChildren()
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |