Module org.refcodes.component

Package org.refcodes.component

Interface PausableHandle<H>

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>, 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

Nested Classes

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.

Method Summary

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.

Method Details

hasPausable

boolean hasPausable(H aHandle)
             throws UnknownHandleRuntimeException

Determines whether the handle reference is pausable by implementing the Pausable 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

void pause(H aHandle)
    throws PauseException,
UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException,
IllegalHandleStateChangeRuntimeException

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

default void pauseUnchecked(H aHandle)

Pauses the component by calling pause(Object) without you to require catching an PauseException.

Parameters:

aHandle - The handle identifying the component.

Throws:

org.refcodes.exception.HiddenException - encapsulates the cause and is thrown upon encountering a PauseException exception