Package eu.bandm.tools.message

Class SingleSender<M extends Message>

java.lang.Object

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

Type Parameters:

M - the message type propagated by this sender

Direct Known Subclasses:

MessageCatcher, MessageMapper, MessagePasser, SimpleMessage.LocationMapper, SimpleMessage.Sender

public abstract class SingleSender<M extends Message>
extends Object

Common superclass of classes which send messages to one single switchable drain. This includes some genuine message sources, ie. senders only, but most of the subclasses are MessageReceivers, which pass on the received messages to that single drain.

That drain can be inquired and set, ie. it can change dynamically during execution. Intentionally, the code will crash if it is equal to null and send(M) is called.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleSender()	Constructor which sets nothing.
protected	SingleSender(@Opt MessageReceiver<? super M> r)	Constructor which sets drain.

Method Summary

Modifier and Type	Method	Description
@Opt MessageReceiver<? super M>	getDrain()	Return the currently active drain.
@Opt MessageReceiver<? super M>	getReceiver()	Deprecated. use getDrain() instead.
void	send(M m)	Send a message to the current drain.
SingleSender<M>	setDrain(@Opt MessageReceiver<? super M> r)	Set the drain for the sent messages.
SingleSender<M>	setReceiver(@Opt MessageReceiver<? super M> r)	Deprecated. use setDrain(eu.bandm.tools.message.MessageReceiver<? super M>) instead.

Methods inherited from class java.lang.Object

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

Field Details

drain

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

Whereto the messages are passed.

Constructor Details

SingleSender

protected SingleSender()

Constructor which sets nothing. After calling this constructor, a call to setReceiver(MessageReceiver) with a non-null argument is necessary before you can use send(Message). Otherwise invoking send(M) will crash intentionally.

SingleSender

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

Constructor which sets drain.

Parameters:

r - the receiver of the sent messages.

See Also:

• setReceiver(eu.bandm.tools.message.MessageReceiver<? super M>)

Method Details

setReceiver

@Deprecated(since="1.0.1")
public SingleSender<M> setReceiver(@Opt
 @Opt MessageReceiver<? super M> r)

Deprecated.

use setDrain(eu.bandm.tools.message.MessageReceiver<? super M>) instead.

Set the receiver of the sent messages. As long as the value of the receiver is null, invoking send(M) will crash intentionally.

Parameters:

r - the receiver of the sent messages.

Returns:

this instance, for method chaining.

setDrain

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

Set the drain for the sent messages. As long as the value of the receiver is null, invoking send(M) will crash intentionally.

Parameters:

r - the drain for the sent messages.

Returns:

this instance, for method chaining.

getReceiver

@Deprecated(since="1.0.1")
@Opt
public @Opt MessageReceiver<? super M> getReceiver()

Deprecated.

use getDrain() instead.

Return the currently active drain.

Returns:

the currently active drain.

getDrain

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

Return the currently active drain.

Returns:

the currently active drain.

send

public void send(M m)

Send a message to the current drain. Intentionally, the code will crash if that is currently null.

Parameters:

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