Module org.refcodes.component
Package org.refcodes.component
Interface BidirectionalConnectionOpenableHandle<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:
BidirectionalConnectionOpenableHandle.BidirectionalConnectionOpenAutomatonHandle<H,INPUT,OUTPUT>
public interface BidirectionalConnectionOpenableHandle<H,INPUT,OUTPUT>
TheBidirectionalConnectionOpenableHandle
interface defines those methods related to the handle based open/connect life-cycle.The handle reference requires the
BidirectionalConnectionOpenable
interface to be implemented.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
BidirectionalConnectionOpenableHandle.BidirectionalConnectionOpenAutomatonHandle<H,INPUT,OUTPUT>
TheBidirectionalConnectionOpenableHandle.BidirectionalConnectionOpenAutomatonHandle
interface defines those methods related to the handle based open/connect life-cycle.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
hasBidirectionalConnectionOpenable(H aHandle)
Determines whether the handle reference isBidirectionalConnectionOpenable
by implementing theBidirectionalConnectionOpenable
interface.void
open(H aHandle, INPUT aInputConnection, OUTPUT aOutputConnection)
Open/connect the component identified by the given handle.
-
-
-
Method Detail
-
hasBidirectionalConnectionOpenable
boolean hasBidirectionalConnectionOpenable(H aHandle) throws UnknownHandleRuntimeException
Determines whether the handle reference isBidirectionalConnectionOpenable
by implementing theBidirectionalConnectionOpenable
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 IOException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegalHandleStateChangeRuntimeException
Open/connect the component identified by the given handle.- Parameters:
aHandle
- The handle identifying the component.aInputConnection
- The input connection used for opening the connection.aOutputConnection
- The output connection used for opening the connection.- Throws:
IOException
- in case opening/connecting 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.
-
-