de.intarsys.claptz

Class InstrumentTools

java.lang.Object

de.intarsys.claptz.InstrumentTools

public class InstrumentTools
extends Object

Constructor Summary

Constructors

Constructor and Description
InstrumentTools()

Method Summary

Methods

Modifier and Type	Method and Description
static IExtension	getLastExtension(IInstrumentRegistry registry, String extensionPointId) A tool method to simplify handling of "singleton" extensions, for example configuration information.
static IExtension	getOrCreateExtension(IInstrument provider, String extensionPointId, String id)
static void	installExtensions(IInstrumentRegistry registry, String point, IExtensionPointHandler functor) Helper method to register all extensions to an extension point correctly.
static boolean	isPrerequisiteImplied(IInstrument instrument, IInstrument requiredInstrument) Check if newPrerequisite is required already directly or indirectly
static IExtension	lookupDefiningExtension(IExtensionPoint extensionPoint, Object object) Lookup the IExtension within extensionPoint that originally defined the object (performed an "insert" operation).
static IInstrument	lookupInstrument(IInstrumentRegistry registry, String instrumentId)
static IInstrument	lookupOrCreateInstrument(IInstrumentRegistry registry, String instrumentId, IInstrumentStore store)
static IExtension	objectDelete(IInstrument provider, String extensionPointId, Object target)
static IExtension	objectInsert(IInstrument provider, String extensionPointId, Object target) Initiate the insertion of the definition for object within an IExtension to provider.
static IExtension	objectUpdate(IInstrument provider, String extensionPointId, Object target)
static void	uninstallExtensions(IInstrumentRegistry registry, String point, IExtensionPointHandler functor) Clean up artifacts / references to functor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstrumentTools

public InstrumentTools()

Method Detail

getLastExtension

public static IExtension getLastExtension(IInstrumentRegistry registry,
                          String extensionPointId)

A tool method to simplify handling of "singleton" extensions, for example configuration information.

Parameters:

extensionPointId -

Returns:

getOrCreateExtension

public static IExtension getOrCreateExtension(IInstrument provider,
                              String extensionPointId,
                              String id)
                                       throws ObjectCreationException,
                                              InstrumentRegistryException

Throws:

ObjectCreationException

InstrumentRegistryException

installExtensions

public static void installExtensions(IInstrumentRegistry registry,
                     String point,
                     IExtensionPointHandler functor)
                              throws InstrumentRegistryException

Helper method to register all extensions to an extension point correctly. This method takes care to call "functor" exactly once for all available and future extensions to IExtensionPoint "point".

It is safe to call this method repeatedly with the identical functor object. Access is synchronized and installation will be executed at most once.

You should take care to uninstallExtensions to protect against memory leaks.

ATTENTION: "functor" must be a unique (not transient) object as it is used as a handle to guard against multiple installs.

Parameters:

point -

elementName -

functor -

Throws:

ExtensionInstallationException

InstrumentRegistryException

isPrerequisiteImplied

public static boolean isPrerequisiteImplied(IInstrument instrument,
                            IInstrument requiredInstrument)

Check if newPrerequisite is required already directly or indirectly

Parameters:

newPrerequisite -

Returns:

lookupDefiningExtension

public static IExtension lookupDefiningExtension(IExtensionPoint extensionPoint,
                                 Object object)

Lookup the IExtension within extensionPoint that originally defined the object (performed an "insert" operation).

Parameters:

extensionPoint -

object -

Returns:

lookupInstrument

public static IInstrument lookupInstrument(IInstrumentRegistry registry,
                           String instrumentId)

lookupOrCreateInstrument

public static IInstrument lookupOrCreateInstrument(IInstrumentRegistry registry,
                                   String instrumentId,
                                   IInstrumentStore store)
                                            throws ObjectCreationException,
                                                   InstrumentRegistryException

Throws:

ObjectCreationException

InstrumentRegistryException

objectDelete

public static IExtension objectDelete(IInstrument provider,
                      String extensionPointId,
                      Object target)
                               throws ObjectCreationException,
                                      InstrumentRegistryException,
                                      InstrumentRegistryException

Throws:

ObjectCreationException

InstrumentRegistryException

objectInsert

public static IExtension objectInsert(IInstrument provider,
                      String extensionPointId,
                      Object target)
                               throws ObjectCreationException,
                                      InstrumentRegistryException

Initiate the insertion of the definition for object within an IExtension to provider.

The system looks up or creates the IExtension for extensionPointId, manages the prerequisites and requests the serialization of the object within the IExtension.

Parameters:

provider -

extensionPointId -

target -

Returns:

Throws:

ObjectCreationException

ExtensionInstallationException

InstrumentRegistryException

objectUpdate

public static IExtension objectUpdate(IInstrument provider,
                      String extensionPointId,
                      Object target)
                               throws ObjectCreationException,
                                      InstrumentRegistryException

Throws:

ObjectCreationException

InstrumentRegistryException

uninstallExtensions

public static void uninstallExtensions(IInstrumentRegistry registry,
                       String point,
                       IExtensionPointHandler functor)
                                throws InstrumentRegistryException

Clean up artifacts / references to functor.

Parameters:

point -

functor -

Throws:

ExtensionInstallationException

InstrumentRegistryException