Module org.refcodes.component
Package org.refcodes.component
Interface StoppableHandle.StopAutomatonHandle<H>
-
- Type Parameters:
H
- The type of the handle.
- All Superinterfaces:
StoppableHandle<H>
- All Known Subinterfaces:
CompositeComponentHandle<H,REF>
,ConfigurableLifeCycleComponentHandle.ConfigurableLifeCycleAutomatonHandle<H,CTX>
,LifeCycleComponentHandle.LifeCycleAutomatonHandle<H>
- Enclosing interface:
- StoppableHandle<H>
public static interface StoppableHandle.StopAutomatonHandle<H> extends StoppableHandle<H>
TheStoppableHandle.StopAutomatonHandle
interface defines those methods related to the handle based stop life-cycle. The handle reference requires theStoppable.StopAutomaton
interface to be implemented.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.component.StoppableHandle
StoppableHandle.StopAutomatonHandle<H>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
hasStopAutomaton(H aHandle)
Determines whether the handle reference is stoppable by implementing theStoppable.StopAutomaton
interface.boolean
isStoppable(H aHandle)
Determines whether the component identified by the given handle may get stopped.boolean
isStopped(H aHandle)
Determines whether the component identified by the given handle is stopped.-
Methods inherited from interface org.refcodes.component.StoppableHandle
hasStoppable, stop, stopUnchecked
-
-
-
-
Method Detail
-
hasStopAutomaton
boolean hasStopAutomaton(H aHandle) throws UnknownHandleRuntimeException
Determines whether the handle reference is stoppable by implementing theStoppable.StopAutomaton
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.
-
isStoppable
boolean isStoppable(H aHandle) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException
Determines whether the component identified by the given handle may get stopped.- Parameters:
aHandle
- The handle identifying the component.- Returns:
- True if
StoppableHandle.stop(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.
-
isStopped
boolean isStopped(H aHandle) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException
Determines whether the component identified by the given handle is stopped.- Parameters:
aHandle
- The handle identifying the component.- Returns:
- True in case of being stopped, 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.
-
-