Package org.openhab.core.events

Class TopicEventFilter

java.lang.Object

org.openhab.core.events.TopicEventFilter

All Implemented Interfaces:

EventFilter

@NonNullByDefault
public class TopicEventFilter
extends Object
implements EventFilter

The TopicEventFilter is a default openHAB EventFilter implementation that ensures filtering of events based on a single event topic or multiple event topics.

Author:

Stefan Bußweiler - Initial contribution, Florian Hotze - Add support for filtering of events by multiple event topics

Constructor Summary

Constructors

Constructor	Description
TopicEventFilter(String topicRegex)	Constructs a new topic event filter.
TopicEventFilter(List<String> topicsRegexes)	Constructs a new topic event filter.

Method Summary

Modifier and Type	Method	Description
boolean	apply(Event event)	Apply the filter on an event.

Methods inherited from class java.lang.Object

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

Constructor Details

TopicEventFilter

public TopicEventFilter(String topicRegex)

Constructs a new topic event filter.

Parameters:

topicRegex - the regular expression of a topic

See Also:

• Java Regex

TopicEventFilter

public TopicEventFilter(List<String> topicsRegexes)

Constructs a new topic event filter.

Parameters:

topicsRegexes - the regular expressions of multiple topics

See Also:

• Java Regex

Method Details

apply

public boolean apply(Event event)

Description copied from interface: EventFilter

Apply the filter on an event.

This method is called for each subscribed Event of an EventSubscriber. If the filter applies, the event will be dispatched to the EventSubscriber.receive(Event) method.

Specified by:

apply in interface EventFilter

Parameters:

event - the event (not null)

Returns:

true if the filter criterion applies