org.lsst.ccs.gconsole.plugins.tracer

Interface MessageFilter

All Superinterfaces:

MessageFilterFactory

All Known Implementing Classes:

MessageFilterAdapter, TracerFilter, UserFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MessageFilter
extends MessageFilterFactory

Interface to be implemented by bus message filters that are directly usable by tracers. Applying this filter to a message may modify the message, in addition to accepting or rejecting it.

This interface extends MessageFilterFactory and provides a default implementation for its get() method. The method is implemented to return the filter itself. This allows registering instances of this class with the graphical console lookup to be picked up by the FilterRegistry. Note that this approach is only safe if the filter's test(...) method can be safely invoked concurrently by multiple threads on multiple messages.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
default MessageFilter	get() Returns a reference to this filter.
FilteredMessage	test(FilteredMessage filteredMessage) Applies this filter to the given message.

Methods inherited from interface org.lsst.ccs.gconsole.plugins.tracer.MessageFilterFactory

getDescription, getName

Method Detail

get

default MessageFilter get()

Returns a reference to this filter.

Specified by:

get in interface MessageFilterFactory

test

FilteredMessage test(FilteredMessage filteredMessage)

Applies this filter to the given message.

Parameters:

filteredMessage - The message to be filtered.

Returns:

The (possibly modified) message if it passes the filter; null otherwise.