Module org.refcodes.component

Package org.refcodes.component

Interface ResetHandle<H>

Type Parameters:

H - The type of the handle.

All Known Subinterfaces:

CompositeComponentHandle<H,REF>

public interface ResetHandle<H>

The ResetHandle interface defines those methods related to the handle based reset operation.

The handle reference requires the Resetable interface to be implemented.

Method Summary

Modifier and Type	Method	Description
boolean	hasReset(H aHandle)	Determines whether the handle reference provides resetting by implementing the Resetable interface.
void	reset(H aHandle)	Resets the component identified by the given handle.

Method Details

hasReset

boolean hasReset(H aHandle)
          throws UnknownHandleRuntimeException

Determines whether the handle reference provides resetting by implementing the Resetable 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 - Thrown in case the handle is unknown (there is none reference for this handle).

reset

void reset(H aHandle)
    throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Resets the component identified by the given handle.

Parameters:

aHandle - The handle identifying the component.

Throws:

UnknownHandleRuntimeException - Thrown in case the handle is unknown (there is none reference for this handle).

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