Package eu.bandm.tools.message

Class MessageTee<M extends Message>

java.lang.Object

eu.bandm.tools.message.MessageTee<M>

All Implemented Interfaces:

MessageReceiver<M>

public class MessageTee<M extends Message>
extends Object
implements MessageReceiver<M>

Re-sends the message received sequentially to a multitude of current drains.
The identical message object is sent to all receivers, so in most use cases it should be treated read-only by subsequent processing in the drains.
For details see receive(Message).

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<MessageReceiver<? super M>>	drains	List of all receivers.

Constructor Summary

Constructors

Constructor	Description
MessageTee()	Simplest constructor.
MessageTee(MessageReceiver<? super M> drain1)	Nonvararg specialization avoids unchecked warnings.
MessageTee(MessageReceiver<? super M>... drains)	Internally calls add(MessageReceiver), please see there.
MessageTee(MessageReceiver<? super M> drain1, MessageReceiver<? super M> drain2)	Nonvararg specialization avoids unchecked warnings Internally calls add(MessageReceiver), please see there.!
MessageTee(MessageReceiver<? super M> drain1, MessageReceiver<? super M> drain2, MessageReceiver<? super M> drain3)	Nonvararg specialization avoids unchecked warnings.

Method Summary

Modifier and Type	Method	Description
void	add(MessageReceiver<? super M> drain)	Adds the message receiver at the end of the list of all current drains.
final void	add(MessageReceiver<? super M>... newdrains)	Internally calls add(MessageReceiver), please see there.
void	add(MessageReceiver<? super M> drain1, MessageReceiver<? super M> drain2)	Nonvararg specialization avoids unchecked warnings.
void	addAll(Iterable<MessageReceiver<? super M>> newdrains)	Internally calls add(MessageReceiver), please see there.
void	clear()	Clear the list of all drains.
List<MessageReceiver<? super M>>	getDrains()	Return an unmodifiable list of all drains.
void	receive(M message)	Propagates the message received sequentially to a multitude of current drains.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.bandm.tools.message.MessageReceiver

ifSubcriticalThen, ifSubcriticalThen, ifSubcriticalThenElse

Field Details

drains

protected final List<MessageReceiver<? super M extends Message>> drains

List of all receivers. The sequential order is respected when sending the message, but in most use cases should not be relevant.

Constructor Details

MessageTee

public MessageTee()

Simplest constructor.

MessageTee

@SafeVarargs
public MessageTee(MessageReceiver<? super M>... drains)

Internally calls add(MessageReceiver), please see there.

MessageTee

public MessageTee(MessageReceiver<? super M> drain1)

Nonvararg specialization avoids unchecked warnings. Internally calls add(MessageReceiver), please see there.!

MessageTee

public MessageTee(MessageReceiver<? super M> drain1,
 MessageReceiver<? super M> drain2)

Nonvararg specialization avoids unchecked warnings Internally calls add(MessageReceiver), please see there.!

MessageTee

public MessageTee(MessageReceiver<? super M> drain1,
 MessageReceiver<? super M> drain2,
 MessageReceiver<? super M> drain3)

Nonvararg specialization avoids unchecked warnings. Internally calls add(MessageReceiver), please see there.!

Method Details

getDrains

public List<MessageReceiver<? super M>> getDrains()

Return an unmodifiable list of all drains.

add

public void add(MessageReceiver<? super M> drain)

Adds the message receiver at the end of the list of all current drains. Cf receive(Message). If it is already contained at some position in the list, it is first removed and then re-inserted at the end of the list.

add

public void add(MessageReceiver<? super M> drain1,
 MessageReceiver<? super M> drain2)

Nonvararg specialization avoids unchecked warnings. Internally calls add(MessageReceiver), please see there.

add

@SafeVarargs
public final void add(MessageReceiver<? super M>... newdrains)

Internally calls add(MessageReceiver), please see there.

addAll

public void addAll(Iterable<MessageReceiver<? super M>> newdrains)

Internally calls add(MessageReceiver), please see there.

clear

public void clear()

Clear the list of all drains.

receive

public void receive(M message)

Propagates the message received sequentially to a multitude of current drains.

If there is one or more MessageThrowers in the pipeline behind these drains, then additionally the message is thrown after all drains have been sent to. (Any other Throwable is, of course, not intercepted!)

Specified by:

receive in interface MessageReceiver<M extends Message>

Parameters:

message - the message to receive.