Package eu.bandm.tools.message

Class SingleSender<M extends Message>

java.lang.Object

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

Type Parameters:

M - the message subtype propagated by this sender

Direct Known Subclasses:

MessageAsync, MessageCatcher, MessageKindFilter, MessageLocationFilter, MessageMapper, MessagePasser, MessageStripExceptions, MessageSync, SimpleMessage.LocationMapper, SimpleMessage.Sender

public abstract class SingleSender<M extends Message>
extends Object

Common superclass of all which send messages to one single drain.

This includes some "genuine message sources", ie. senders only, but most of the subclasses are MessageReceivers, which pass on the received messages to one single drain.

This drain can be enquired and set, ie. it can change dynamically during execution. Intentionally, the code will crash if a receiver==null and a send is attempted

Field Summary

Fields

Modifier and Type	Field	Description
protected @Opt MessageReceiver<? super M>	receiver	Whereto the messages are passed.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleSender()	After calling this constructor, a call to setReceiver(MessageReceiver) is necessary before you can use send(Message).
protected	SingleSender(@Opt MessageReceiver<? super M> r)	Constructor which sets receiver.

Method Summary

Modifier and Type	Method	Description
@Opt MessageReceiver<? super M>	getReceiver()	Evident.
void	send(M m)	Used to pass on a message to the current receiver.
void	setReceiver(@Opt MessageReceiver<? super M> r)	Evident.

Methods inherited from class java.lang.Object

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

Field Details

receiver

@Opt
protected @Opt MessageReceiver<? super M extends Message> receiver

Whereto the messages are passed.

Constructor Details

SingleSender

protected SingleSender()

After calling this constructor, a call to setReceiver(MessageReceiver) is necessary before you can use send(Message). Otherwise code will crash intentionally.

SingleSender

protected SingleSender(@Opt
 @Opt MessageReceiver<? super M> r)

Constructor which sets receiver.

Parameters:

r - the receiver of the sent messages.

Method Details

setReceiver

public void setReceiver(@Opt
 @Opt MessageReceiver<? super M> r)

Evident.

Parameters:

r - the receiver of the sent messages.

getReceiver

@Opt
public @Opt MessageReceiver<? super M> getReceiver()

Evident.

Returns:

the currently active receiver.

send

public void send(M m)

Used to pass on a message to the current receiver.
Intentionally, the code will crash if this is ==null

Parameters:

m - the message to be sent to the current receiver.