org.trianacode.taskgraph

Interface Cable

All Known Subinterfaces:

InputCable, IOCable, OutputCable

All Known Implementing Classes:

CableImp, DataCable, LocalCable, QueueCable, RunnableCable

public interface Cable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTROL_CABLE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	addCableListener(CableListener listener) Adds a cable listener to this cable.
void	connect(Node sendnode, Node recnode) Connect two nodes with this cable.
boolean	connects(Task task)
boolean	contains(Node node)
void	disconnect() Disconnect this cable from its nodes.
Node	getReceivingNode()
Task	getReceivingTask()
Node	getSendingNode()
Task	getSendingTask()
java.lang.String	getType()
boolean	isConnected()
void	reconnect(Node recnode) Reconnects the cable to receive from/send to the specified node
void	removeCableListener(CableListener listener) Removes a cable listener from this cable.

Field Detail

CONTROL_CABLE_TYPE

static final java.lang.String CONTROL_CABLE_TYPE

See Also:

Constant Field Values

Method Detail

addCableListener

void addCableListener(CableListener listener)

Adds a cable listener to this cable.

removeCableListener

void removeCableListener(CableListener listener)

Removes a cable listener from this cable.

getType

java.lang.String getType()

Returns:

the type of the cable

isConnected

boolean isConnected()

Returns:

true is this cable is connected.

getSendingNode

Node getSendingNode()

Returns:

the node which sends data along this cable

getSendingTask

Task getSendingTask()

Returns:

the task which sends data (via a node) along this cable

getReceivingNode

Node getReceivingNode()

Returns:

the node which receives data along this cable

getReceivingTask

Task getReceivingTask()

Returns:

the task which receives data (via a node) along this cable

contains

boolean contains(Node node)

Returns:

true if the specified node sends data to or receives data from this cable

connects

boolean connects(Task task)

Returns:

true if the specified task sends data to or receives data from this cable

connect

void connect(Node sendnode,
           Node recnode)
             throws CableException

Connect two nodes with this cable.

Throws:

CableException

reconnect

void reconnect(Node recnode)
               throws CableException

Reconnects the cable to receive from/send to the specified node

Throws:

CableException

disconnect

void disconnect()
                throws CableException

Disconnect this cable from its nodes. Note that a disconnected cable cannot be reconnected.

Throws:

CableException