H
- The type of the handle.CompositeComponentHandle<H,REF>
, ConfigurableLifeCycleComponentHandle<H,CTX>
, ConfigurableLifeCycleComponentHandle.ConfigurableLifeCycleAutomatonHandle<H,CTX>
, LifeCycleComponentHandle<H>
, LifeCycleComponentHandle.LifeCycleAutomatonHandle<H>
, PausableHandle.PauseAutomatonHandle<H>
public interface PausableHandle<H>
PausableHandle
interface defines those methods related to the
handle based pause life-cycle.
The handle reference requires the Pausable
interface to be
implemented.
Modifier and Type | Interface | Description |
---|---|---|
static interface |
PausableHandle.PauseAutomatonHandle<H> |
The
PausableHandle.PauseAutomatonHandle interface defines those methods related
to the handle based pause life-cycle. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
hasPausable(H aHandle) |
Determines whether the handle reference is pausable by implementing the
Pausable interface. |
void |
pause(H aHandle) |
Pauses the component identified by the given handle.
|
default void |
pauseUnchecked(H aHandle) |
Pauses the component by calling
pause(Object) without you to
require catching an PauseException . |
boolean hasPausable(H aHandle) throws UnknownHandleRuntimeException
Pausable
interface.aHandle
- The handle to test whether the reference provides the
according functionality.UnknownHandleRuntimeException
- in case the handle is unknown.void pause(H aHandle) throws PauseException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegalHandleStateChangeRuntimeException
aHandle
- The handle identifying the component.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.default void pauseUnchecked(H aHandle)
pause(Object)
without you to
require catching an PauseException
.aHandle
- The handle identifying the component.org.refcodes.exception.HiddenException
- encapsulates the cause and is thrown upon
encountering a PauseException
exceptionCopyright © 2018. All rights reserved.