Module org.refcodes.component

Package org.refcodes.component

Interface BidirectionalConnectionOpenable<INPUT,OUTPUT>

Type Parameters:

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

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

All Known Subinterfaces:

BidirectionalConnectionComponent<INPUT,OUTPUT>, BidirectionalConnectionComponent.BidirectionalConnectionAutomaton<INPUT,OUTPUT>, BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton<INPUT,OUTPUT>

public interface BidirectionalConnectionOpenable<INPUT,OUTPUT>

This mixin might be implemented by a component in order to provide opening connection(s) facilities. The semantics of this interface is very similar to that of the Configurable interface. To clarify the context regarding connections, the BidirectionalConnectionOpenable interface has been introduced.

In case a no connection is to be provided to the open(Object, Object) method (as it may have been passed via the constructor), you may use the Openable interface with its Openable.open() method, which does not require any arguments specifying a connection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton<INPUT,OUTPUT>	The BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton interface defines those methods related to the opening of connection(s) life-cycle.

Method Summary

Modifier and Type	Method	Description
void	open(INPUT aInputConnection, OUTPUT aOutputConnection)	Opens the component with the given connection, the component opens a connection with the given connection.

Method Details

open

void open(INPUT aInputConnection,
 OUTPUT aOutputConnection)
   throws IOException

Opens the component with the given connection, the component opens a connection with the given connection.

Parameters:

aInputConnection - The input connection used for opening the connection.

aOutputConnection - The output connection used for opening the connection.

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.