Package etomica.data

Class DataFork

java.lang.Object

etomica.data.DataFork

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink

public class DataFork
extends java.lang.Object
implements DataPipeForked

DataSink that takes a data stream and forwards it across multiple sinks.

Field Summary

Fields

Modifier and Type	Field	Description
protected IDataInfo	dataInfo
protected IDataSink[]	dataSinkList
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
DataFork()	Constructs with no initial DataSinks.
DataFork(IDataSink[] dataSinks)	Constructs to forward data to the given sinks.

Method Summary

Modifier and Type	Method	Description
void	addDataSink(IDataSink newDataSink)	Adds the given DataSink to those receiving the Data entering this DataFork, keeping all previously entered DataSinks.
IDataSink[]	getDataSinks()
DataTag	getTag()
void	putData(IData data)	Puts the given Data through into all DataSinks.
void	putDataInfo(IDataInfo incomingDataInfo)	Puts the given DataInfo through into all DataSinks, inserting a data caster before any sinks needing one.
void	removeDataSink(IDataSink dataSink)	Removes the specified data sink.
void	setDataSink(IDataSink dataSink)	Sets the given DataSink as the only one connected to this DataFork.
void	setDataSinks(IDataSink[] dataSinks)	Sets the list of DataSinks that receive the Data entering this DataFork.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tag

protected final DataTag tag

dataSinkList

protected IDataSink[] dataSinkList

dataInfo

protected IDataInfo dataInfo

Constructor Detail

DataFork

public DataFork()

Constructs with no initial DataSinks. Sinks can be added and removed after construction using appropriate method calls.

DataFork

public DataFork(IDataSink[] dataSinks)

Constructs to forward data to the given sinks. Sinks can be added and removed after construction using appropriate method calls.

Method Detail

getTag

public DataTag getTag()

Specified by:

getTag in interface DataPipe

putData

public void putData(IData data)

Puts the given Data through into all DataSinks. Does nothing if given Data is null.

Specified by:

putData in interface IDataSink

putDataInfo

public void putDataInfo(IDataInfo incomingDataInfo)

Puts the given DataInfo through into all DataSinks, inserting a data caster before any sinks needing one.

Specified by:

putDataInfo in interface IDataSink

getDataSinks

public IDataSink[] getDataSinks()

Specified by:

getDataSinks in interface DataPipeForked

Returns:

the i-th DataSink

setDataSinks

public void setDataSinks(IDataSink[] dataSinks)

Description copied from interface: DataPipeForked

Sets the list of DataSinks that receive the Data entering this DataFork. All previously added DataSinks are discarded. If argument is null, all existing DataSinks are discarded and none are added.

Specified by:

setDataSinks in interface DataPipeForked

Parameters:

dataSinks - The data sinks to set.

setDataSink

public void setDataSink(IDataSink dataSink)

Sets the given DataSink as the only one connected to this DataFork. Previously set DataSinks are discarded. If argument is null, this DataFork will be left with no DataSinks.

Implementation of DataPipe interface.

Specified by:

setDataSink in interface DataPipe

Parameters:

dataSink - the new, sole DataSink connected to this DataFork

addDataSink

public void addDataSink(IDataSink newDataSink)

Description copied from interface: DataPipeForked

Adds the given DataSink to those receiving the Data entering this DataFork, keeping all previously entered DataSinks. If argument is null, no action is performed.

Specified by:

addDataSink in interface DataPipeForked

removeDataSink

public void removeDataSink(IDataSink dataSink)

Description copied from interface: DataPipeForked

Removes the specified data sink. Does nothing if the given DataSink is not currently a DataSink for this DataFork.

Specified by:

removeDataSink in interface DataPipeForked

Parameters:

dataSink - data sink to be removed from this list, if present.