- Type Parameters:
H
- The type of the handle.
- All Known Subinterfaces:
ComponentHandleComposite<H,
,REF> ConfigurableLifecycleComponentHandle.ConfigurableLifecycleAutomatonHandle<H,
,CTX> InitializableHandle.InitializeAutomatonHandle<H>
,LifecycleComponentHandle<H>
,LifecycleComponentHandle.LifecycleAutomatonHandle<H>
public interface InitializableHandle<H>
The
InitializableHandle
interface defines those methods related to
the handle based initialize life-cycle.
The handle reference requires the Initializable
interface to be
implemented.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
TheInitializableHandle.InitializeAutomatonHandle
interface defines those methods related to the handle based initialize life-cycle. -
Method Summary
Modifier and TypeMethodDescriptionboolean
hasInitalizable
(H aHandle) Determines whether the handle reference is initializeable by implementing theInitializable
interface.void
initialize
(H aHandle) Initialize the component identified by the given handle.default void
initializeUnchecked
(H aHandle) Initialize the component by callinginitialize(Object)
without you to require catching anInitializeException
.
-
Method Details
-
hasInitalizable
Determines whether the handle reference is initializeable by implementing theInitializable
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) throws InitializeException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegalHandleStateChangeRuntimeException Initialize the component identified by the given handle.- Parameters:
aHandle
- The handle identifying the component.- Throws:
InitializeException
- in case initializing 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.
-
initializeUnchecked
Initialize the component by callinginitialize(Object)
without you to require catching anInitializeException
.- Parameters:
aHandle
- The handle identifying the component.- Throws:
InitializeException.InitializeRuntimeException
- encapsulates the cause and is thrown upon encountering aInitializeException
exception
-