Package org.openhab.core.io.websocket.event

Class TopicFilterMapper

java.lang.Object

org.openhab.core.io.websocket.event.TopicFilterMapper

@NonNullByDefault
public final class TopicFilterMapper
extends Object

The TopicFilterMapper is used for mapping topic filter expression from the topic filter WebSocketEvent to TopicEventFilter.

Author:

Florian Hotze - Initial contribution

Method Summary

Modifier and Type	Method	Description
static @Nullable TopicEventFilter	mapTopicsToExcludeFilter(List<String> topics)	Maps the topic expressions to a TopicEventFilter for event exclusion.
static @Nullable TopicEventFilter	mapTopicsToIncludeFilter(List<String> topics)	Maps the topic expressions to a TopicEventFilter for event inclusion.

Methods inherited from class java.lang.Object

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

Method Details

mapTopicsToIncludeFilter

public static @Nullable TopicEventFilter mapTopicsToIncludeFilter(List<String> topics)
                                                           throws EventProcessingException

Maps the topic expressions to a TopicEventFilter for event inclusion.

Parameters:

topics - the topic expressions

Returns:

the TopicEventFilter or `null` if there are no inclusions defined

Throws:

EventProcessingException - if a topic expression is invalid, i.e. neither a valid topic value, expression using the * wildcard or regular expression

mapTopicsToExcludeFilter

public static @Nullable TopicEventFilter mapTopicsToExcludeFilter(List<String> topics)
                                                           throws EventProcessingException

Maps the topic expressions to a TopicEventFilter for event exclusion.

Parameters:

topics - the topic expressions

Returns:

the TopicEventFilter or `null` if there are no exclusions defined

Throws:

EventProcessingException - if a topic expression is invalid, i.e. neither a valid topic value, expression using the * wildcard or regular expression