org.youscope.addon.callback

Interface CallbackAddonFactory

All Known Implementing Classes:

DropletMicrofluidicJobCallbackFactory, LiveModifiableJobCallbackFactory, RemoteScriptEngineFactory, UserControlMeasurementCallbackFactory, WaitForUserCallbackFactory

public interface CallbackAddonFactory

A factory to create measurement callbacks. Per measurement, there exist only one instance of each implementation of CallbackAddonFactory. Thus, singletons (per measurement) can be realized by always returning the same callback object.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
Callback	createCallback(java.lang.String typeIdentifier, YouScopeClient client, YouScopeServer server) Returns a new measurement callback for the given type identifier.
java.lang.String[]	getSupportedTypeIdentifiers() Returns a list of all callback type identifiers supported by this factory.
boolean	isSupportingTypeIdentifier(java.lang.String typeIdentifier) Returns true if this factory supports callback with the given type identifier, false otherwise.

Method Detail

createCallback

Callback createCallback(java.lang.String typeIdentifier,
                        YouScopeClient client,
                        YouScopeServer server)
                 throws CallbackCreationException

Returns a new measurement callback for the given type identifier.

Parameters:

typeIdentifier - The ID for which a callback should be created.

measurement - Measurement which creates the callback.

client - Interface to allow the addon to communicate with the client.

server - Interface to the server.

Returns:

The created addon for a given type identifier.

Throws:

CallbackCreationException - Thrown if callback type identifier is not supported by this factory, or if any general error occurred during the callback creation.

getSupportedTypeIdentifiers

java.lang.String[] getSupportedTypeIdentifiers()

Returns a list of all callback type identifiers supported by this factory.

Returns:

List of supported callback types.

isSupportingTypeIdentifier

boolean isSupportingTypeIdentifier(java.lang.String typeIdentifier)

Returns true if this factory supports callback with the given type identifier, false otherwise.

Parameters:

typeIdentifier - The ID of the callback type for which it should be queried if this factory supports its construction.

Returns:

True if this factory supports creating callback with the given ID, false otherwise.