public abstract class CConfigurationDataProvider extends Object
Constructor and Description |
---|
CConfigurationDataProvider() |
Modifier and Type | Method and Description |
---|---|
CConfigurationData |
applyConfiguration(ICConfigurationDescription cfgDescription,
ICConfigurationDescription baseCfgDescription,
CConfigurationData baseData,
IModificationContext context,
org.eclipse.core.runtime.IProgressMonitor monitor)
Called during the setProjectDescription operation to notify the provider that the configuration data
is being applied.
|
CConfigurationData |
applyConfiguration(ICConfigurationDescription cfgDescription,
ICConfigurationDescription baseCfgDescription,
CConfigurationData baseData,
org.eclipse.core.runtime.IProgressMonitor monitor)
The method is called in case the implementer does NOT override method
applyConfiguration(ICConfigurationDescription, ICConfigurationDescription, CConfigurationData, IModificationContext, IProgressMonitor) . |
abstract CConfigurationData |
createConfiguration(ICConfigurationDescription cfgDescription,
ICConfigurationDescription baseCfgDescription,
CConfigurationData baseData,
boolean clone,
org.eclipse.core.runtime.IProgressMonitor monitor)
Requests the Configuration Data to be created for the given ConfigurationDescription.
|
void |
dataCached(ICConfigurationDescription cfgDescription,
CConfigurationData data,
org.eclipse.core.runtime.IProgressMonitor monitor)
Called to notify that the configuration data was cached.
|
abstract CConfigurationData |
loadConfiguration(ICConfigurationDescription cfgDescription,
org.eclipse.core.runtime.IProgressMonitor monitor)
Requests the Configuration Data to be loaded for the given ConfigurationDescription.
|
abstract void |
removeConfiguration(ICConfigurationDescription cfgDescription,
CConfigurationData data,
org.eclipse.core.runtime.IProgressMonitor monitor)
Called to notify the provider that the configuration is removed.
|
public abstract CConfigurationData loadConfiguration(ICConfigurationDescription cfgDescription, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
cfgDescription
- - configuration description being loaded.monitor
- - progress monitor.org.eclipse.core.runtime.CoreException
public abstract CConfigurationData createConfiguration(ICConfigurationDescription cfgDescription, ICConfigurationDescription baseCfgDescription, CConfigurationData baseData, boolean clone, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
cfgDescription
- - configuration description for the configuration data being created.baseCfgDescription
- - configuration description for the configuration data the new data to be based upon.baseData
- - configuration data the new data to be based upon.clone
- - true
indicates that the configuration copy (clone) is being created for the copy description.monitor
- - progress monitor.false
indicates that the new configuration is being created based upon the already existing one via
ICProjectDescription.createConfiguration method call, true
otherwise.org.eclipse.core.runtime.CoreException
public abstract void removeConfiguration(ICConfigurationDescription cfgDescription, CConfigurationData data, org.eclipse.core.runtime.IProgressMonitor monitor)
cfgDescription
- - configuration description being removed.data
- - configuration data.monitor
- - progress monitor.public CConfigurationData applyConfiguration(ICConfigurationDescription cfgDescription, ICConfigurationDescription baseCfgDescription, CConfigurationData baseData, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
applyConfiguration(ICConfigurationDescription, ICConfigurationDescription, CConfigurationData, IModificationContext, IProgressMonitor)
.cfgDescription
- - configuration description where the configuration data are being applied to.baseCfgDescription
- - configuration description of the configuration data being applied.baseData
- - configuration data being applied.org.eclipse.core.runtime.CoreException
public CConfigurationData applyConfiguration(ICConfigurationDescription cfgDescription, ICConfigurationDescription baseCfgDescription, CConfigurationData baseData, IModificationContext context, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
cfgDescription
- - configuration description where the configuration data are being applied to.baseCfgDescription
- - configuration description of the configuration data being applied.baseData
- - configuration data being applied.context
- the IModificationContext
allows registering workspace runnables to be run
as a single batch workspace operation.
If possible the runnables will be run directly in the apply context(thread) after all
configuration datas get applied. Otherwise runnables will be run as a separate job.
This allows to perform all workspace modifications registered by different configurations
to be run as a single batch operation together with the workspace modifications performed by the
ICProjectDescription
framework.monitor
- - progress monitor.org.eclipse.core.runtime.CoreException
public void dataCached(ICConfigurationDescription cfgDescription, CConfigurationData data, org.eclipse.core.runtime.IProgressMonitor monitor)
cfgDescription
- - configuration description which was cached.data
- - configuration data.monitor
- - progress monitor.Copyright (c) IBM Corp. and others 2004, 2020. All Rights Reserved.