org.dromara.mica.mqtt.core.common

Enum TopicFilterType

java.lang.Object

java.lang.Enum<TopicFilterType>

org.dromara.mica.mqtt.core.common.TopicFilterType

All Implemented Interfaces:

Serializable, Comparable<TopicFilterType>

public enum TopicFilterType
extends Enum<TopicFilterType>

TopicFilter 类型

Author:

L.cm

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE 默认 TopicFilter
QUEUE $queue/ 为前缀的共享订阅是不带群组的共享订阅
SHARE $share/{group-name}/ 为前缀的共享订阅是带群组的共享订阅

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHARE_GROUP_PREFIX
static String	SHARE_QUEUE_PREFIX 共享订阅的 topic

Method Summary

Modifier and Type	Method and Description
static String	getShareGroupName(String topicFilter) 读取共享订阅的分组名
abstract Map<String,String>	getTopicVars(String topicTemplate, String topic) 解析 topic 模板中的变量 例如 $SYS/brokers/${node}/clients/${clientid}/disconnected 中提取 node 和 clientid
static TopicFilterType	getType(String topicFilter) 获取 topicFilter 类型
abstract boolean	match(String topicFilter, String topicName) 判断 topicFilter 和 topicName 匹配情况
static TopicFilterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TopicFilterType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final TopicFilterType NONE

默认 TopicFilter

QUEUE

public static final TopicFilterType QUEUE

$queue/ 为前缀的共享订阅是不带群组的共享订阅

SHARE

public static final TopicFilterType SHARE

$share/{group-name}/ 为前缀的共享订阅是带群组的共享订阅

Field Detail

SHARE_QUEUE_PREFIX

public static final String SHARE_QUEUE_PREFIX

共享订阅的 topic

See Also:

Constant Field Values

SHARE_GROUP_PREFIX

public static final String SHARE_GROUP_PREFIX

See Also:

Constant Field Values

Method Detail

values

public static TopicFilterType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TopicFilterType c : TopicFilterType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TopicFilterType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

match

public abstract boolean match(String topicFilter,
                              String topicName)

判断 topicFilter 和 topicName 匹配情况

Parameters:

topicFilter - topicFilter

topicName - topicName

Returns:

是否匹配

getTopicVars

public abstract Map<String,String> getTopicVars(String topicTemplate,
                                                String topic)

解析 topic 模板中的变量 例如 $SYS/brokers/${node}/clients/${clientid}/disconnected 中提取 node 和 clientid

Parameters:

topicTemplate - topicTemplate

topic - topic

Returns:

提取的变量

getType

public static TopicFilterType getType(String topicFilter)

获取 topicFilter 类型

Parameters:

topicFilter - topicFilter

Returns:

TopicFilterType

getShareGroupName

public static String getShareGroupName(String topicFilter)

读取共享订阅的分组名

Parameters:

topicFilter - topicFilter

Returns:

共享订阅分组名