- 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>
,PausableHandle.PauseAutomatonHandle<H>
public interface PausableHandle<H>
The
PausableHandle
interface defines those methods related to the
handle based pause life-cycle.
The handle reference requires the Pausable
interface to be
implemented.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
ThePausableHandle.PauseAutomatonHandle
interface defines those methods related to the handle based pause life-cycle. -
Method Summary
Modifier and TypeMethodDescriptionboolean
hasPausable
(H aHandle) Determines whether the handle reference is pausable by implementing thePausable
interface.void
Pauses the component identified by the given handle.default void
pauseUnchecked
(H aHandle) Pauses the component by callingpause(Object)
without you to require catching anPauseException
.
-
Method Details
-
hasPausable
Determines whether the handle reference is pausable by implementing thePausable
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.
-
pause
Pauses the component identified by the given handle.- Parameters:
aHandle
- The handle identifying the component.- Throws:
PauseException
- in case pausing 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.
-
pauseUnchecked
Pauses the component by callingpause(Object)
without you to require catching anPauseException
.- Parameters:
aHandle
- The handle identifying the component.- Throws:
PauseException.PauseRuntimeException
- encapsulates the aCause and is thrown upon encountering aPauseException
exception
-