Package eu.bandm.tools.message

Class MessageLevelFilter<M extends Message>

java.lang.Object

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

Type Parameters:

M - the message subtype which can be received

All Implemented Interfaces:

MessageReceiver<M>

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

A filter which sends messages only to its sink if their level value is equal to or below a given threshold.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) MessageReceiver<? super M>	drain
(package private) int	level
(package private) EnumSet<Message.Kind>	unfiltered

Constructor Summary

Constructors

Constructor	Description
MessageLevelFilter()
MessageLevelFilter(MessageReceiver<M> drain)

Method Summary

Modifier and Type	Method	Description
void	receive(M m)	Evident
MessageLevelFilter<M>	setDrain(MessageReceiver<? super M> drain)
MessageLevelFilter<M>	setLevel(int level)
MessageLevelFilter<M>	setUnfilteredKinds(EnumSet<Message.Kind> unfiltered)	Define the set of Message.Kind which will not be filtered by the threshold, i.e. which will always be forwarded.

Methods inherited from class java.lang.Object

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

Field Details

level

int level

drain

MessageReceiver<? super M extends Message> drain

unfiltered

EnumSet<Message.Kind> unfiltered

Constructor Details

MessageLevelFilter

public MessageLevelFilter()

MessageLevelFilter

public MessageLevelFilter(MessageReceiver<M> drain)

Method Details

setDrain

public MessageLevelFilter<M> setDrain(MessageReceiver<? super M> drain)

setLevel

public MessageLevelFilter<M> setLevel(int level)

setUnfilteredKinds

public MessageLevelFilter<M> setUnfilteredKinds(EnumSet<Message.Kind> unfiltered)

Define the set of Message.Kind which will not be filtered by the threshold, i.e. which will always be forwarded. The initial setting lets all error and failure messages pass, what is appropriate in most use cases.

receive

public void receive(M m)

Description copied from interface: MessageReceiver

Evident

Specified by:

receive in interface MessageReceiver<M extends Message>