-
- 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>
,StoppableHandle.StopAutomatonHandle<H>
public interface StoppableHandle<H>
TheStoppableHandle
interface defines those methods related to the handle based stop life-cycle.The handle reference requires the
Stoppable
interface to be implemented.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
StoppableHandle.StopAutomatonHandle<H>
TheStoppableHandle.StopAutomatonHandle
interface defines those methods related to the handle based stop life-cycle.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
hasStoppable(H aHandle)
Determines whether the handle reference is stoppable by implementing theStoppable
interface.void
stop(H aHandle)
Stops the component identified by the given handle.default void
stopUnchecked(H aHandle)
Stops the component by callingstop(Object)
without you to require catching anStopException
.
-
-
-
Method Detail
-
hasStoppable
boolean hasStoppable(H aHandle) throws UnknownHandleRuntimeException
Determines whether the handle reference is stoppable by implementing theStoppable
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.
-
stop
void stop(H aHandle) throws StopException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegalHandleStateChangeRuntimeException
Stops the component identified by the given handle.- Parameters:
aHandle
- The handle identifying the component.- Throws:
StopException
- in case stopping 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.
-
stopUnchecked
default void stopUnchecked(H aHandle)
Stops the component by callingstop(Object)
without you to require catching anStopException
.- Parameters:
aHandle
- The handle identifying the component.- Throws:
StopException.StopRuntimeException
- encapsulates the cause and is thrown upon encountering aStopException
exception
-
-