CeasableHandle (org.refcodes:refcodes-component 1.10.1 API)

Type Parameters:

H - The type of the handle.

All Known Subinterfaces:

CeasableHandle.CeaseAutomatonHandle<H>
```
public interface CeasableHandle<H>
```
The CeasableHandle interface defines those methods related to the handle based cease life-cycle.
The handle reference requires the Ceasable interface to be implemented.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`CeasableHandle.CeaseAutomatonHandle<H>`	The `CeasableHandle.CeaseAutomatonHandle` interface defines those methods related to the handle based cease life-cycle.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cease(H aHandle)`	Ceases the component identified by the given handle.
`boolean`	`hasCeasable(H aHandle)`	Determines whether the handle reference is ceasable by implementing the `Ceasable` interface.

- Method Detail
  - hasCeasable
```
boolean hasCeasable(H aHandle)
             throws UnknownHandleRuntimeException
```
    Determines whether the handle reference is ceasable by implementing the Ceasable 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.
  - cease
```
void cease(H aHandle)
    throws CeaseException,
           UnknownHandleRuntimeException,
           UnsupportedHandleOperationRuntimeException,
           IllegalHandleStateChangeRuntimeException
```
    Ceases the component identified by the given handle.
    
    Parameters:
    
    aHandle - The handle identifying the component.
    
    Throws:
    
    CeaseException - in case ceasing 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.