Package eu.bandm.tools.message

Class MessageKindFilter<M extends Message>

java.lang.Object

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

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

All Implemented Interfaces:

MessageReceiver<M>

public class MessageKindFilter<M extends Message>
extends SingleSender<M>
implements MessageReceiver<M>

A filter which propagates only those messages the Message.Kind of which is currently in the selection.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Message.Kind>	kinds	The selected kinds.

Fields inherited from class eu.bandm.tools.message.SingleSender

receiver

Constructor Summary

Constructors

Constructor	Description
MessageKindFilter(MessageReceiver<? super M> d)	Constructor with no kind is initially selected.
MessageKindFilter(MessageReceiver<? super M> d, Message.Kind... kk)	Constructor with given kinds initially selected.

Method Summary

Modifier and Type	Method	Description
MessageKindFilter<M>	addAllCriticalKinds()	Adds all Message.Kinds which are marked as critical.
MessageKindFilter<M>	addAllKinds()	Add all Message.Kind to the filter.
MessageKindFilter<M>	addKind(Message.Kind k)	Adds the kind to selection.
MessageKindFilter<M>	addKind(Message.Kind... kk)	Adds the kinds kinds to selection.
void	receive(M m)	Propagate to the SingleSender.receiver if message's kind is in selection.
MessageKindFilter<M>	removeAllKinds()	Evident.
MessageKindFilter<M>	removeKind(Message.Kind k)	Remove the kind from selection
MessageKindFilter<M>	removeKind(Message.Kind... kk)	Remove the kinds from selection

Methods inherited from class eu.bandm.tools.message.SingleSender

getReceiver, send, setReceiver

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

kinds

protected Set<Message.Kind> kinds

The selected kinds.

Constructor Details

MessageKindFilter

public MessageKindFilter(MessageReceiver<? super M> d)

Constructor with no kind is initially selected.

Parameters:

d - the receiver of the messages.

MessageKindFilter

public MessageKindFilter(MessageReceiver<? super M> d,
 Message.Kind... kk)

Constructor with given kinds initially selected.

Parameters:

d - the receiver of the messages.

kk - the kinds initially selected.

Method Details

addAllCriticalKinds

public MessageKindFilter<M> addAllCriticalKinds()

Adds all Message.Kinds which are marked as critical.

Returns:

this for message chaining.

See Also:

• Message.isCritical()

addKind

public MessageKindFilter<M> addKind(Message.Kind k)

Adds the kind to selection.

Parameters:

k - kind to add.

Returns:

this for message chaining.

addKind

public MessageKindFilter<M> addKind(Message.Kind... kk)

Adds the kinds kinds to selection.

Parameters:

kk - kinds to add.

Returns:

this for message chaining.

addAllKinds

public MessageKindFilter<M> addAllKinds()

Add all Message.Kind to the filter.

Returns:

this for message chaining.

removeKind

public MessageKindFilter<M> removeKind(Message.Kind k)

Remove the kind from selection

Parameters:

k - kind to remove.

Returns:

this for message chaining.

removeKind

public MessageKindFilter<M> removeKind(Message.Kind... kk)

Remove the kinds from selection

Parameters:

kk - kinds to remove.

Returns:

this for message chaining.

removeAllKinds

public MessageKindFilter<M> removeAllKinds()

Evident.

Returns:

this for message chaining.

receive

public void receive(M m)

Propagate to the SingleSender.receiver if message's kind is in selection.

Specified by:

receive in interface MessageReceiver<M extends Message>

Parameters:

m - message to propagate.