|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
void store(ContentReference contentReference, IProgressMonitor monitor) throws CoreException
contentReference
- content reference to feature filemonitor
- progress monitor, can be null
CoreException
open(IPluginEntry)
,
open(INonPluginEntry)
IContentConsumer open(IPluginEntry pluginEntry) throws CoreException
pluginEntry
- plug-in entry
CoreException
IContentConsumer open(INonPluginEntry nonPluginEntry) throws CoreException
nonPluginEntry
- non-plug-in entry
CoreException
IFeatureReference close() throws CoreException
CoreException
void abort() throws CoreException
CoreException
void setFeature(IFeature feature)
feature
- feature for this content consumerIFeature getFeature()
void setParent(IFeatureContentConsumer parent)
parent
- parent feature content consumer.IFeatureContentConsumer getParent()
null
if this feature content consumer is a root feature
content consumer.
void addChild(IFeature feature) throws CoreException
feature
- the child feature.
CoreException
IFeatureContentConsumer[] getChildren()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |