Package com.hivemq.client.mqtt.mqtt5.datatypes

Interface Mqtt5UserProperty

All Superinterfaces:

Comparable<Mqtt5UserProperty>

@DoNotImplement
public interface Mqtt5UserProperty
extends Comparable<Mqtt5UserProperty>

MQTT User Property according to the MQTT 5 specification.

A User Property consists of a name and value UTF-8 encoded String Pair.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull MqttUtf8String	getName()
@NotNull MqttUtf8String	getValue()
static @NotNull Mqtt5UserProperty	of(@NotNull MqttUtf8String name, @NotNull MqttUtf8String value)	Creates an User Property of the given name and value.
static @NotNull Mqtt5UserProperty	of(@NotNull String name, @NotNull String value)	Creates an User Property of the given name and value.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

of

@NotNull
static @NotNull Mqtt5UserProperty of(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String value)

Creates an User Property of the given name and value.

Parameters:

name - the name of the User Property.

value - the value of the User Property.

Returns:

the created User Property.

of

@NotNull
static @NotNull Mqtt5UserProperty of(@NotNull
 @NotNull MqttUtf8String name,
 @NotNull
 @NotNull MqttUtf8String value)

Creates an User Property of the given name and value.

Parameters:

name - the name of the User Property.

value - the value of the User Property.

Returns:

the created User Property.

getName

@NotNull
@NotNull MqttUtf8String getName()

Returns:

the name of this User Property.

getValue

@NotNull
@NotNull MqttUtf8String getValue()

Returns:

the value of this User Property.