Class TopicEventFilter

  • All Implemented Interfaces:
    EventFilter

    public class TopicEventFilter
    extends Object
    implements EventFilter
    The TopicEventFilter is a default openHAB EventFilter implementation that ensures filtering of events based on an event topic.
    Author:
    Stefan Bußweiler - Initial contribution
    • Constructor Detail

      • TopicEventFilter

        public TopicEventFilter​(String topicRegex)
        Constructs a new topic event filter.
        Parameters:
        topicRegex - the regular expression of a topic
        See Also:
        Java Regex
    • Method Detail

      • 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