Module org.refcodes.component

Package org.refcodes.component

Interface PausableHandle.PauseAutomatonHandle<H>

Type Parameters:

H - The type of the handle.

All Superinterfaces:

PausableHandle<H>

All Known Subinterfaces:

CompositeComponentHandle<H,REF>, ConfigurableLifeCycleComponentHandle.ConfigurableLifeCycleAutomatonHandle<H,CTX>, LifeCycleComponentHandle.LifeCycleAutomatonHandle<H>

Enclosing interface:

PausableHandle<H>

public static interface PausableHandle.PauseAutomatonHandle<H>
extends PausableHandle<H>

The PausableHandle.PauseAutomatonHandle interface defines those methods related to the handle based pause life-cycle. The handle reference requires the Pausable.PauseAutomaton interface to be implemented.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.PausableHandle

PausableHandle.PauseAutomatonHandle<H>

Method Summary

Modifier and Type	Method	Description
boolean	hasPauseAutomaton(H aHandle)	Determines whether the handle reference is pausable by implementing the Pausable.PauseAutomaton interface.
boolean	isPausable(H aHandle)	Determines whether the component identified by the given handle may get paused.
boolean	isPaused(H aHandle)	Determines whether the component identified by the given handle is paused.

Methods inherited from interface org.refcodes.component.PausableHandle

hasPausable, pause, pauseUnchecked

Method Details

hasPauseAutomaton

boolean hasPauseAutomaton(H aHandle)
                   throws UnknownHandleRuntimeException

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

isPausable

boolean isPausable(H aHandle)
            throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Determines whether the component identified by the given handle may get paused.

Parameters:

aHandle - The handle identifying the component.

Returns:

True if PausableHandle.pause(Object) is possible.

Throws:

UnknownHandleRuntimeException - in case the given handle is unknown.

UnsupportedHandleOperationRuntimeException - in case the reference of the handle does not support the requested operation.

isPaused

boolean isPaused(H aHandle)
          throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Determines whether the component identified by the given handle is paused.

Parameters:

aHandle - The handle identifying the component.

Returns:

True in case of being paused, else false.

Throws:

UnknownHandleRuntimeException - in case the given handle is unknown.

UnsupportedHandleOperationRuntimeException - in case the reference of the handle does not support the requested operation.