SingleSender (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.message.SingleSender<M>

Direct Known Subclasses:

LocationMap.Translator, MessageAsync, MessageCatcher, MessageKindFilter, MessageLocationFilter, MessageMapper, MessagePasser, MessageStripExceptions, MessageSync, MuLiMessageReceiver, SimpleMessage.Sender
```
public abstract class SingleSender<M extends Message>
extends java.lang.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
Constructor	Description
`SingleSender()`	After calling this constructor, a call to `setReceiver(MessageReceiver)` is necessary before you can use `send(Message)`.
`SingleSender(@Opt MessageReceiver<? super M> r)`	Constructor which sets `receiver`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@Opt MessageReceiver<? super M>`	`getReceiver()`	Evident
`protected 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 Detail
  - receiver
```
@Opt
protected @Opt MessageReceiver<? super M extends Message> receiver
```
    Whereto the messages are passed.
- Constructor Detail
  - SingleSender
```
public SingleSender()
```
    After calling this constructor, a call to setReceiver(MessageReceiver) is necessary before you can use send(Message). Otherwise code will crash intentionally.
  - SingleSender
```
public SingleSender(@Opt
                    @Opt MessageReceiver<? super M> r)
```
    Constructor which sets receiver.
- Method Detail
  - setReceiver
```
public void setReceiver(@Opt
                        @Opt MessageReceiver<? super M> r)
```
    Evident
  - getReceiver
```
@Opt
public @Opt MessageReceiver<? super M> getReceiver()
```
    Evident
  - send
```
protected void send(M m)
```
    Used to pass on a message to the current receiver.
    Intentionally, the code will crash if this is ==null