rsb.filter

Class OriginFilter

java.lang.Object

rsb.filter.OriginFilter

All Implemented Interfaces:

Filter

public class OriginFilter
extends Object
implements Filter

Events matched by this filter have to originate from a particular participant.

Author:

swrede, jmoringe

Constructor Summary

Constructors

Constructor and Description
OriginFilter(ParticipantId origin) Constructor.
OriginFilter(ParticipantId origin, boolean invert) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object that)
ParticipantId	getOrigin() Returns the origin participant id this filter operates for.
int	hashCode()
boolean	isInverted() Indicates whether the filter accepts events only from the id returned by getOrigin() or it only accepts events that do not originate from that origin.
boolean	match(Event event) Tells whether the given event matches the filter and hence shall be dispatched or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

OriginFilter

public OriginFilter(ParticipantId origin,
            boolean invert)

Constructor.

Parameters:

origin - the desired origin of a received event, not null

invert - if true, suppress events from the provided origin and allow all other events instead of only allowing events from that origin.

Throws:

IllegalArgumentException - origin is null

OriginFilter

public OriginFilter(ParticipantId origin)

Constructor.

Parameters:

origin - only events from this origin are allowed, not null

Throws:

IllegalArgumentException - origin is null

Method Detail

getOrigin

public ParticipantId getOrigin()

Returns the origin participant id this filter operates for.

Returns:

the id, not null

isInverted

public boolean isInverted()

Indicates whether the filter accepts events only from the id returned by getOrigin() or it only accepts events that do not originate from that origin.

Returns:

if true, only events NOT originating from getOrigin() are allowed. If false, only events from getOrigin() are allowed.

match

public boolean match(Event event)

Description copied from interface: Filter

Tells whether the given event matches the filter and hence shall be dispatched or not.

Specified by:

match in interface Filter

Parameters:

event - the event to test, not null

Returns:

true if the event matches the restrictions specified by this filter and hence can be delivered to the client, false to remove the event from the stream.

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object