Module org.refcodes.component

Package org.refcodes.component

Interface ClosableHandle.CloseAutomatonHandle<H>

Type Parameters:

H - The type of the handle.

All Superinterfaces:

ClosableHandle<H>

Enclosing interface:

ClosableHandle<H>

public static interface ClosableHandle.CloseAutomatonHandle<H>
extends ClosableHandle<H>

The ClosableHandle.CloseAutomatonHandle interface defines those methods related to the handle based close life-cycle. The handle reference requires the ConnectionOpenable.ConnectionOpenAutomaton interface to be implemented.

Nested Class Summary

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

ClosableHandle.CloseAutomatonHandle<H>

Method Summary

Modifier and Type	Method	Description
boolean	hasCloseAutomaton(H aHandle)	Determines whether the handle reference is closable by implementing the ConnectionOpenable.ConnectionOpenAutomaton interface.
boolean	isClosable(H aHandle)	Determines whether the component identified by the given handle may get closed/disconnected.
boolean	isClosed(H aHandle)	Determines whether the component (its connection) identified by the given handle is closed (disconnected).

Methods inherited from interface org.refcodes.component.ClosableHandle

close, closeUnchecked, hasClosable

Method Details

hasCloseAutomaton

boolean hasCloseAutomaton(H aHandle)
                   throws UnknownHandleRuntimeException

Determines whether the handle reference is closable by implementing the ConnectionOpenable.ConnectionOpenAutomaton 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.

isClosable

boolean isClosable(H aHandle)
            throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Determines whether the component identified by the given handle may get closed/disconnected.

Parameters:

aHandle - The handle identifying the component.

Returns:

True if ClosableHandle.close(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.

isClosed

boolean isClosed(H aHandle)
          throws UnknownHandleRuntimeException,
UnsupportedHandleOperationRuntimeException

Determines whether the component (its connection) identified by the given handle is closed (disconnected).

Parameters:

aHandle - The handle identifying the component.

Returns:

True in case of being closed, 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.