cn.starboot.mqtt.codec

类 MqttProperties

java.lang.Object

cn.starboot.mqtt.codec.MqttProperties

public final class MqttProperties
extends Object

MQTT Properties container

作者:

netty, L.cm, MDong

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	MqttProperties.BinaryProperty
static class	MqttProperties.IntegerProperty
static class	MqttProperties.MqttProperty<T> MQTT property base class
static class	MqttProperties.MqttPropertyType
static class	MqttProperties.StringPair
static class	MqttProperties.StringProperty
static class	MqttProperties.UserProperties
static class	MqttProperties.UserProperty

字段概要

字段

限定符和类型	字段和说明
private boolean	canModify
static MqttProperties	NO_PROPERTIES
private Map<Integer,MqttProperties.MqttProperty>	props
private List<MqttProperties.IntegerProperty>	subscriptionIds
private List<MqttProperties.UserProperty>	userProperties

构造器概要

构造器

限定符	构造器和说明
	MqttProperties()
private	MqttProperties(boolean canModify)

方法概要

限定符和类型	方法和说明
void	add(MqttProperties.MqttProperty property)
List<? extends MqttProperties.MqttProperty>	getProperties(int propertyId) Get properties by ID.
MqttProperties.MqttProperty	getProperty(int propertyId) Get property by ID.
MqttProperties.MqttProperty	getProperty(MqttProperties.MqttPropertyType mqttPropertyType) Get property by ID.
<T> T	getPropertyValue(MqttProperties.MqttPropertyType mqttPropertyType) Get property by ID.
boolean	isEmpty()
Collection<? extends MqttProperties.MqttProperty>	listAll()
(专用程序包) static MqttProperties	withEmptyDefaults(MqttProperties properties)

从类继承的方法 java.lang.Object

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

字段详细资料

NO_PROPERTIES

public static final MqttProperties NO_PROPERTIES

props

private Map<Integer,MqttProperties.MqttProperty> props

userProperties

private List<MqttProperties.UserProperty> userProperties

subscriptionIds

private List<MqttProperties.IntegerProperty> subscriptionIds

canModify

private final boolean canModify

构造器详细资料

MqttProperties

public MqttProperties()

MqttProperties

private MqttProperties(boolean canModify)

方法详细资料

withEmptyDefaults

static MqttProperties withEmptyDefaults(MqttProperties properties)

add

public void add(MqttProperties.MqttProperty property)

listAll

public Collection<? extends MqttProperties.MqttProperty> listAll()

isEmpty

public boolean isEmpty()

getProperty

public MqttProperties.MqttProperty getProperty(int propertyId)

Get property by ID. If there are multiple properties of this type (can be with Subscription ID) then return the first one.

参数:

propertyId - ID of the property

返回:

a property if it is set, null otherwise

getProperty

public MqttProperties.MqttProperty getProperty(MqttProperties.MqttPropertyType mqttPropertyType)

Get property by ID. If there are multiple properties of this type (can be with Subscription ID) then return the first one.

参数:

mqttPropertyType - Type of the property

返回:

a property if it is set, null otherwise

getPropertyValue

public <T> T getPropertyValue(MqttProperties.MqttPropertyType mqttPropertyType)

Get property by ID. If there are multiple properties of this type (can be with Subscription ID) then return the first one.

类型参数:

T - 泛型标记

参数:

mqttPropertyType - Type of the property

返回:

a property value if it is set, null otherwise

getProperties

public List<? extends MqttProperties.MqttProperty> getProperties(int propertyId)

Get properties by ID. Some properties (Subscription ID and User Properties) may occur multiple times, this method returns all their values in order.

参数:

propertyId - ID of the property

返回:

all properties having specified ID