Module org.refcodes.component

Package org.refcodes.component

Interface StartableHandle<H>

Type Parameters:

H - The type of the handle.

All Known Subinterfaces:

CompositeComponentHandle<H,REF>, ConfigurableLifeCycleComponentHandle<H,CTX>, ConfigurableLifeCycleComponentHandle.ConfigurableLifeCycleAutomatonHandle<H,CTX>, LifeCycleComponentHandle<H>, LifeCycleComponentHandle.LifeCycleAutomatonHandle<H>, StartableHandle.StartAutomatonHandle<H>

public interface StartableHandle<H>

The StartableHandle interface defines those methods related to the handle based start life-cycle.

The handle reference requires the Startable interface to be implemented.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StartableHandle.StartAutomatonHandle<H>	The StartableHandle.StartAutomatonHandle interface defines those methods related to the handle based start life-cycle.

Method Summary

Modifier and Type	Method	Description
boolean	hasStartable(H aHandle)	Determines whether the handle reference is startable by implementing the Startable interface.
void	start(H aHandle)	Starts the component identified by the given handle.
default void	startUnchecked(H aHandle)	Starts the component by calling start(Object) without you to require catching an StartException.

Method Details

hasStartable

boolean hasStartable(H aHandle)
              throws UnknownHandleRuntimeException

Determines whether the handle reference is startable by implementing the Startable 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.

start

void start(H aHandle)
    throws StartException,
UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException,
IllegalHandleStateChangeRuntimeException

Starts the component identified by the given handle.

Parameters:

aHandle - The handle identifying the component.

Throws:

StartException - in case starting fails.

UnknownHandleRuntimeException - in case the given handle is unknown.

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

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

startUnchecked

default void startUnchecked(H aHandle)

Starts the component by calling start(Object) without you to require catching an StartException.

Parameters:

aHandle - The handle identifying the component.

Throws:

org.refcodes.exception.HiddenException - encapsulates the cause and is thrown upon encountering a StartException exception