org.refcodes.component

Interface ConfigurableHandle<H,CTX>

Type Parameters:

H - The type of the handle.

CTX - The context used to initialize the referenced instance.

All Known Subinterfaces:

ConfigurableHandle.ConfigureAutomatonHandle<H,CTX>, ConfigurableLifeCycleComponentHandle<H,CTX>, ConfigurableLifeCycleComponentHandle.ConfigurableLifeCycleAutomatonHandle<H,CTX>

public interface ConfigurableHandle<H,CTX>

The ConfigurableHandle interface defines those methods related to the handle based initialize/configure life-cycle.

The handle reference requires the Configurable interface to be implemented.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigurableHandle.ConfigureAutomatonHandle<H,CTX> The ConfigurableHandle.ConfigureAutomatonHandle interface defines those methods related to the handle based initialize/configure life-cycle.

Method Summary

Modifier and Type	Method and Description
boolean	hasConfigurable(H aHandle) Determines whether the handle reference is configurable by implementing the Configurable interface.
void	initialize(H aHandle, CTX aContext) Initialize/configure the component identified by the given handle.

Method Detail

hasConfigurable

boolean hasConfigurable(H aHandle)
                 throws UnknownHandleRuntimeException

Determines whether the handle reference is configurable by implementing the Configurable interface.

Parameters:

aHandle - The handle to test whether the reference provides the according functionality.

Returns:

True in case the reference provides the according functionality.

Throws:

UnknownHandleRuntimeException - in case the handle is unknown.

initialize

void initialize(H aHandle,
                CTX aContext)
         throws ConfigureException,
                UnknownHandleRuntimeException,
                UnsupportedHandleOperationRuntimeException,
                IllegaleHandleStateChangeRuntimeException

Initialize/configure the component identified by the given handle.

Parameters:

aContext - The context to be passed to the implementing instance.

aHandle - The handle identifying the component.

Throws:

ConfigureException - in case initializing fails.

UnsupportedHandleOperationRuntimeException - in case the reference of the handle does not support the requested operation.

UnknownHandleRuntimeException - in case the given handle is unknown.

IllegaleHandleStateChangeRuntimeException - Thrown in case a state change is not possible due to the current state the referenced component is in.