org.dromara.mica.mqtt.codec

Class MqttProperties

java.lang.Object

org.dromara.mica.mqtt.codec.MqttProperties

public final class MqttProperties
extends Object

MQTT Properties container

Author:

netty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Field Summary

Fields

Modifier and Type	Field and Description
static MqttProperties	NO_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
MqttProperties()

Method Summary

Modifier and Type	Method and Description
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()

Methods inherited from class java.lang.Object

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

Field Detail

NO_PROPERTIES

public static final MqttProperties NO_PROPERTIES

Constructor Detail

MqttProperties

public MqttProperties()

Method Detail

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.

Parameters:

propertyId - ID of the property

Returns:

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.

Parameters:

mqttPropertyType - Type of the property

Returns:

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.

Type Parameters:

T - 泛型标记

Parameters:

mqttPropertyType - Type of the property

Returns:

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.

Parameters:

propertyId - ID of the property

Returns:

all properties having specified ID