EGF Engine
Release 0.1.0

org.eclipse.egf.pde.internal.plugin.extension
Class ContextExtensionFactory

java.lang.Object
  extended by org.eclipse.egf.pde.internal.plugin.extension.ContextExtensionFactory
All Implemented Interfaces:
IContextExtensionFactory

public class ContextExtensionFactory
extends Object
implements IContextExtensionFactory

This factory creates commands to deal with "context" extension-point.


Method Summary
static ContextExtensionFactory getInstance()
          Get the unique instance.
 IPluginChangesCommand setContextElementBasedOnContractElementRef(String contextId_p, String contextElementId_p, String contractElementReferenceId_p, String value_p)
          Set a context element based on a contract element reference in a context extension for given parameters.
 IPluginChangesCommand setContextElementBasedOnKey(String contextId_p, String contextElementId_p, String keyValue_p, String keyType_p, String value_p)
          Set a context element based on a key in a context extension for given parameters.
 IPluginChangesCommand setContextExtension(String contextId_p)
          Set an extension matching "context" extension-point for given parameters.
 IPluginChangesCommand unsetContextElement(String contextId_p, String contextElementId_p)
          Unset a context element from a context extension for given parameters.
 IPluginChangesCommand unsetContextExtension(String contextId_p)
          Unset an extension matching "context" extension-point for given parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static ContextExtensionFactory getInstance()
Get the unique instance.

Returns:

setContextExtension

public IPluginChangesCommand setContextExtension(String contextId_p)
Description copied from interface: IContextExtensionFactory
Set an extension matching "context" extension-point for given parameters.

Specified by:
setContextExtension in interface IContextExtensionFactory
Returns:
an IPluginChangesCommand instance that performs this change.
See Also:
IContextExtensionFactory.setContextExtension(java.lang.String)

unsetContextExtension

public IPluginChangesCommand unsetContextExtension(String contextId_p)
Description copied from interface: IContextExtensionFactory
Unset an extension matching "context" extension-point for given parameters.

Specified by:
unsetContextExtension in interface IContextExtensionFactory
Returns:
an IPluginChangesCommand instance that performs this change.
See Also:
IContextExtensionFactory.unsetContextExtension(java.lang.String)

setContextElementBasedOnContractElementRef

public IPluginChangesCommand setContextElementBasedOnContractElementRef(String contextId_p,
                                                                        String contextElementId_p,
                                                                        String contractElementReferenceId_p,
                                                                        String value_p)
Description copied from interface: IContextExtensionFactory
Set a context element based on a contract element reference in a context extension for given parameters.

Specified by:
setContextElementBasedOnContractElementRef in interface IContextExtensionFactory
Parameters:
contextId_p - context that the context element is added in.
contextElementId_p - id of the created context element.
contractElementReferenceId_p - reference to a contract element defined in a ContractReferences extension-point.
value_p - string value.
Returns:
an IPluginChangesCommand instance that performs this change.
See Also:
IContextExtensionFactory.setContextElementBasedOnContractElementRef(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

setContextElementBasedOnKey

public IPluginChangesCommand setContextElementBasedOnKey(String contextId_p,
                                                         String contextElementId_p,
                                                         String keyValue_p,
                                                         String keyType_p,
                                                         String value_p)
Description copied from interface: IContextExtensionFactory
Set a context element based on a key in a context extension for given parameters.

Specified by:
setContextElementBasedOnKey in interface IContextExtensionFactory
Parameters:
contextId_p - context that the context element is added in.
contextElementId_p - id of the created context element.
keyValue_p - key value.
keyType_p - key type.
value_p - the value to set.
Returns:
an IPluginChangesCommand instance that performs this change.
See Also:
IContextExtensionFactory.setContextElementBasedOnKey(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

unsetContextElement

public IPluginChangesCommand unsetContextElement(String contextId_p,
                                                 String contextElementId_p)
Description copied from interface: IContextExtensionFactory
Unset a context element from a context extension for given parameters.

Specified by:
unsetContextElement in interface IContextExtensionFactory
Returns:
See Also:
IContextExtensionFactory.unsetContextElement(java.lang.String, java.lang.String)

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.