com.ibm.xtools.mmi.core.services.sync

Interface ISourceSynchronizationProvider

All Superinterfaces:

org.eclipse.gmf.runtime.common.core.service.IProvider

All Known Implementing Classes:

AbstractSourceSynchronizationProvider, SourceSynchronizationService

public interface ISourceSynchronizationProvider
extends org.eclipse.gmf.runtime.common.core.service.IProvider

Interface that defines the implementation contract for the CodeProvider extension point. All artifacts registered against this extension point should implement this interface.

See Also:

SourceSynchronizationService, ModelChangeDelta

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXT_POINT_TAG The Extension Point Schema Tag for the SourceSynchronizationProviders Extension.
static java.lang.String	HANDLER_ID_TAG The Extension Point Schema Tag for the StructuredReferenceProviderId element.
static java.lang.String	ID_ATTRIBUTE_TAG The Extension Point Schema Tag for the id attribute of the StructuredReferenceProviderId element.

Method Summary

Modifier and Type	Method and Description
org.eclipse.gmf.runtime.common.core.command.ICommand	emit(ModelChangeDelta delta) Generates an ICommand based on the provided ModelChangeDelta that, when executed, will complete all operations necessary to alter the corresponding domain element managed by this provider implementation.

Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider

addProviderChangeListener, provides, removeProviderChangeListener

Field Detail

EXT_POINT_TAG

static final java.lang.String EXT_POINT_TAG

The Extension Point Schema Tag for the SourceSynchronizationProviders Extension.

See Also:

Constant Field Values

HANDLER_ID_TAG

static final java.lang.String HANDLER_ID_TAG

The Extension Point Schema Tag for the StructuredReferenceProviderId element.

See Also:

Constant Field Values

ID_ATTRIBUTE_TAG

static final java.lang.String ID_ATTRIBUTE_TAG

The Extension Point Schema Tag for the id attribute of the StructuredReferenceProviderId element.

See Also:

Constant Field Values

Method Detail

emit

org.eclipse.gmf.runtime.common.core.command.ICommand emit(ModelChangeDelta delta)

Generates an ICommand based on the provided ModelChangeDelta that, when executed, will complete all operations necessary to alter the corresponding domain element managed by this provider implementation. The returned ICommand must not attempt to make changes to the Semantic or Notational models directly. The command must also expect to be appended to an encapsulating Compound command that may contain other ICommands contributed by other providers registered against the CodeProviders extension point.

IMPORTANT: If the affected domain element is under source control, the generated ICommand's execute() method must ensure the file is writable (e.g. by performing a checkout if necessary) before modifying the domain element.

Parameters:

delta - the ModelChangeDelta to be handled.

Returns:

the ICommand whose execution will effect the necessary changes (if any) to the appropriate source elements.