com.github.leanframeworks.minibus.base.filter

Class TopicFilter<C>

java.lang.Object

com.github.leanframeworks.minibus.base.filter.TopicFilter<C>

Type Parameters:

C - Type of content in the event.

All Implemented Interfaces:

EventFilter<C>

public class TopicFilter<C>
extends Object
implements EventFilter<C>

Event filter implementation based on topics.

Constructor Summary

Constructors

Constructor and Description
TopicFilter(boolean accept, Collection<Topic<? extends C>> topics) Constructor.
TopicFilter(boolean accept, Topic<? extends C>... topics) Constructor.
TopicFilter(Collection<Topic<? extends C>> topics) Constructor.
TopicFilter(Topic<? extends C>... topics) Constructor.
TopicFilter(Topic<? extends C> topic) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Event<C> event) States whether the event should be passed to the event handler that was registered with it.
void	addTopic(Topic<? extends C> topic) Adds the specified topic for which the events should either be accepted or rejected.
void	removeTopic(Topic<? extends C> topic) Removes the specified topic for which the events should now be either rejected or accepted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.leanframeworks.minibus.api.EventFilter

and, not, or

Constructor Detail

TopicFilter

public TopicFilter(Topic<? extends C> topic)

Constructor.

Parameters:

topic - Topic for which the events are either accepted.

TopicFilter

@SafeVarargs
public TopicFilter(Topic<? extends C>... topics)

Constructor.

Parameters:

topics - Topics for which the events are either accepted.

TopicFilter

public TopicFilter(Collection<Topic<? extends C>> topics)

Constructor.

Parameters:

topics - Topics for which the events are either accepted.

TopicFilter

@SafeVarargs
public TopicFilter(boolean accept,
                                Topic<? extends C>... topics)

Constructor.

Parameters:

accept - True if the filter should accept events for the given topics, false if it should reject events for the given topics.

topics - Topics for which the events are either accepted or rejected.

TopicFilter

public TopicFilter(boolean accept,
                   Collection<Topic<? extends C>> topics)

Constructor.

Parameters:

accept - True if the filter should accept events for the given topics, false if it should reject events for the given topics.

topics - Topics for which the events are either accepted or rejected.

Method Detail

addTopic

public void addTopic(Topic<? extends C> topic)

Adds the specified topic for which the events should either be accepted or rejected.

Parameters:

topic - Event topic to be added.

removeTopic

public void removeTopic(Topic<? extends C> topic)

Removes the specified topic for which the events should now be either rejected or accepted.

Parameters:

topic - Event topic to be removed.

accept

public boolean accept(Event<C> event)

Description copied from interface: EventFilter

States whether the event should be passed to the event handler that was registered with it.

Specified by:

accept in interface EventFilter<C>

Parameters:

event - Event to be filtered in or out.

Returns:

True if the event can be passed to the interested event handler, false otherwise.

See Also:

EventFilter.accept(Event)