- Type Parameters:
H
- The type of the handle.
- All Known Subinterfaces:
ComponentHandleComposite<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
Modifier and TypeInterfaceDescriptionstatic interface
TheStartableHandle.StartAutomatonHandle
interface defines those methods related to the handle based start life-cycle. -
Method Summary
Modifier and TypeMethodDescriptionboolean
hasStartable
(H aHandle) Determines whether the handle reference is startable by implementing theStartable
interface.void
Starts the component identified by the given handle.default void
startUnchecked
(H aHandle) Starts the component by callingstart(Object)
without you to require catching anStartException
.
-
Method Details
-
hasStartable
Determines whether the handle reference is startable by implementing theStartable
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
Starts the component by callingstart(Object)
without you to require catching anStartException
.- Parameters:
aHandle
- The handle identifying the component.- Throws:
StartException.StartRuntimeException
- encapsulates the cause and is thrown upon encountering aStartException
exception
-