org.lsst.ccs.messaging

Class BusMessageFilter

java.lang.Object

org.lsst.ccs.messaging.BusMessageFilter

All Implemented Interfaces:

java.util.function.Predicate<BusMessage>

public abstract class BusMessageFilter
extends Object
implements java.util.function.Predicate<BusMessage>

A BusMessageFilter provides methods for creating and combining filters for BusMessages. A BusMessageFilter can be used when registering a Bus Listener. An example of creating a BusMessageFilter selecting for BusMessages from an origin and of a given type is: BusMessageFilter filter = BusMessageFilter.messageOrigin("abc").and(BusMessageFilter .messageClass(SomeMessage.class));

Constructor Summary

Constructors

Constructor and Description
BusMessageFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(BusMessage busMessage) Check if a BusMessage passes this filter.
BusMessageFilter	and(BusMessageFilter filter)
static BusMessageFilter	embeddedObjectClass(Class clazz) Create BusMessageFilter on the class of the object embedded in a StatusMessage.
static BusMessageFilter	fromPredicate(java.util.function.Predicate<BusMessage> p)
protected abstract boolean	internalAccept(BusMessage busMessage)
protected abstract String	internalToString()
static BusMessageFilter	messageClass(Class clazz) Create BusMessageFilter on the class of a BusMessage.
static BusMessageFilter	messageOrigin(String origin) Create BusMessageFilter on the origin of a BusMessage.
static BusMessageFilter	messageSummary(String summary) Deprecated.
BusMessageFilter	negate()
BusMessageFilter	or(BusMessageFilter filter)
boolean	test(BusMessage busMessage) Check if a BusMessage passes this filter.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, or

Constructor Detail

BusMessageFilter

public BusMessageFilter()

Method Detail

messageOrigin

public static BusMessageFilter messageOrigin(String origin)

Create BusMessageFilter on the origin of a BusMessage. The filter will select BusMessages from the provided origin.

Parameters:

origin - The origin of the desired BusMessages

Returns:

A BusMessageFilter on the origin of a BusMessage.

embeddedObjectClass

public static BusMessageFilter embeddedObjectClass(Class clazz)

Create BusMessageFilter on the class of the object embedded in a StatusMessage. The filter will select StatusMessages that contain an object that can be assigned from the provided clazz.

Parameters:

clazz - The clazz of the desired object embedded in a StatusMessages

Returns:

A BusMessageFilter on the class of an object embedded in a StatusMessage.

messageClass

public static BusMessageFilter messageClass(Class clazz)

Create BusMessageFilter on the class of a BusMessage. The filter will select BusMessages that can be assigned from the provided clazz.

Parameters:

clazz - The clazz of the desired BusMessages

Returns:

A BusMessageFilter on the origin of a BusMessage.

messageSummary

@Deprecated
public static BusMessageFilter messageSummary(String summary)

Deprecated.

Create BusMessageFilter on the summary of a BusMessage. The filter will select BusMessages that contain the provided String as part of their summary.

Parameters:

summary - The String used to match the summary of a BusMessages

Returns:

A BusMessageFilter on the summary of a BusMessage.

accept

public boolean accept(BusMessage busMessage)

Check if a BusMessage passes this filter.

Parameters:

busMessage - The BusMessage to test.

Returns:

True if the BusMessage passes the BusMessageFilter.

test

public boolean test(BusMessage busMessage)

Check if a BusMessage passes this filter. Implemented to call accept(busMessage).

Specified by:

test in interface java.util.function.Predicate<BusMessage>

Parameters:

busMessage - The BusMessage to test.

Returns:

True if the BusMessage passes the BusMessageFilter.

or

public BusMessageFilter or(BusMessageFilter filter)

and

public BusMessageFilter and(BusMessageFilter filter)

negate

public BusMessageFilter negate()

Specified by:

negate in interface java.util.function.Predicate<BusMessage>

fromPredicate

public static BusMessageFilter fromPredicate(java.util.function.Predicate<BusMessage> p)

internalAccept

protected abstract boolean internalAccept(BusMessage busMessage)

internalToString

protected abstract String internalToString()

toString

public String toString()

Overrides:

toString in class Object