org.lsst.ccs.messaging

Class BusMessageFilter

java.lang.Object

org.lsst.ccs.messaging.BusMessageFilter

public abstract class BusMessageFilter
extends Object

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.
protected void	addAnd(BusMessageFilter filter)
protected void	addOr(BusMessageFilter filter)
BusMessageFilter	and(BusMessageFilter filter) AND two BusMessageFilters.
protected Object	clone()
protected abstract boolean	internalAccept(BusMessage busMessage)
protected abstract BusMessageFilter	internalClone()
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) Create BusMessageFilter on the summary of a BusMessage.
BusMessageFilter	not() Negate the selection logic of a BusMessageFilter.
BusMessageFilter	or(BusMessageFilter filter) OR two BusMessageFilters.
String	toString()
protected void	updateClone(BusMessageFilter f)

Methods inherited from class java.lang.Object

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

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.

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

public static BusMessageFilter messageSummary(String summary)

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.

not

public BusMessageFilter not()

Negate the selection logic of a BusMessageFilter.

Returns:

A clone of the original BusMessageFilter with the negated logic.

or

public BusMessageFilter or(BusMessageFilter filter)

OR two BusMessageFilters.

Parameters:

filter - The filter to OR with.

Returns:

A clone of the original BusMessageFilter ORed to the provided one.

and

public BusMessageFilter and(BusMessageFilter filter)

AND two BusMessageFilters.

Parameters:

filter - The filter to AND with.

Returns:

A clone of the original BusMessageFilter ANDed to the provided one.

addOr

protected void addOr(BusMessageFilter filter)

addAnd

protected void addAnd(BusMessageFilter filter)

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.

internalAccept

protected abstract boolean internalAccept(BusMessage busMessage)

internalToString

protected abstract String internalToString()

internalClone

protected abstract BusMessageFilter internalClone()

updateClone

protected void updateClone(BusMessageFilter f)

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

toString

public String toString()

Overrides:

toString in class Object