org.refcodes.component.mixins

Interface InputOutputOpenableHandle<H,INPUT,OUTPUT>

Type Parameters:

H - The type of the handle.

INPUT - The type of the input connection to be used.

OUTPUT - The type of the output connection to be used.

All Known Subinterfaces:

InputOutputOpenableHandle.InputOutputOpenAutomatonHandle<H,INPUT,OUTPUT>

public interface InputOutputOpenableHandle<H,INPUT,OUTPUT>

The InputOutputOpenableHandle interface defines those methods related to the handle based open/connect life-cycle.

The handle reference requires the InputOutputOpenable interface to be implemented.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InputOutputOpenableHandle.InputOutputOpenAutomatonHandle<H,INPUT,OUTPUT> The InputOutputOpenableHandle.InputOutputOpenAutomatonHandle interface defines those methods related to the handle based open/connect life-cycle.

Method Summary

Modifier and Type	Method and Description
boolean	hasInputOutputOpenable(H aHandle) Determines whether the handle reference is InputOutputOpenable by implementing the InputOutputOpenable interface.
void	open(H aHandle, INPUT aInputConnection, OUTPUT aOutputConnection) Open/connect the component identified by the given handle.

Method Detail

hasInputOutputOpenable

boolean hasInputOutputOpenable(H aHandle)
                        throws UnknownHandleRuntimeException

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

open

void open(H aHandle,
          INPUT aInputConnection,
          OUTPUT aOutputConnection)
   throws OpenException,
          UnknownHandleRuntimeException,
          UnsupportedHandleOperationRuntimeException,
          IllegaleHandleStateChangeRuntimeException

Open/connect the component identified by the given handle.

Parameters:

aInputConnection - The input connection used for opening the connection.

aOutputConnection - The output connection used for opening the connection.

aHandle - The handle identifying the component.

Throws:

OpenException - in case opening/connecting fails.

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

UnknownHandleRuntimeException - in case the given handle is unknown.

IllegaleHandleStateChangeRuntimeException - Thrown in case a state change is not possible due to the current state the referenced component is in.