com.hivemq.client.internal.mqtt.datatypes

Class MqttUserPropertiesImpl

java.lang.Object

com.hivemq.client.internal.mqtt.datatypes.MqttUserPropertiesImpl

All Implemented Interfaces:

Mqtt5UserProperties

@Immutable
public class MqttUserPropertiesImpl
extends java.lang.Object
implements Mqtt5UserProperties

See Also:

Mqtt5UserProperties

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull MqttUserPropertiesImpl	NO_USER_PROPERTIES Empty collection of User Properties.

Method Summary

Modifier and Type	Method and Description
@NotNull ImmutableList<MqttUserPropertyImpl>	asList()
static @NotNull MqttUserPropertiesImpl	build(ImmutableList.Builder<MqttUserPropertyImpl> userPropertiesBuilder) Builds a collection of User Properties from the given builder.
void	encode(@NotNull io.netty.buffer.ByteBuf out) Encodes this collection of User Properties to the given byte buffer at the current writer index.
int	encodedLength() Calculates the byte count of this collection of User Properties according to the MQTT 5 specification.
boolean	equals(@Nullable java.lang.Object o)
MqttUserPropertiesImplBuilder.Default	extend()
int	hashCode()
static @NotNull MqttUserPropertiesImpl	of(@NotNull ImmutableList<MqttUserPropertyImpl> userProperties) Creates a collection of User Properties from the given immutable list of User Properties.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.datatypes.Mqtt5UserProperties

builder, of, of, of

Field Detail

NO_USER_PROPERTIES

@NotNull
public static final @NotNull MqttUserPropertiesImpl NO_USER_PROPERTIES

Empty collection of User Properties.

Method Detail

of

@NotNull
public static @NotNull MqttUserPropertiesImpl of(@NotNull
                                                          @NotNull ImmutableList<MqttUserPropertyImpl> userProperties)

Creates a collection of User Properties from the given immutable list of User Properties.

Parameters:

userProperties - the immutable list of User Properties.

Returns:

the created collection of User Properties or NO_USER_PROPERTIES if the list is empty.

build

@NotNull
public static @NotNull MqttUserPropertiesImpl build(@Nullable
                                                             ImmutableList.Builder<MqttUserPropertyImpl> userPropertiesBuilder)

Builds a collection of User Properties from the given builder.

Parameters:

userPropertiesBuilder - the builder for the User Properties.

Returns:

the built collection of User Properties or NO_USER_PROPERTIES if the builder is null.

asList

@NotNull
public @NotNull ImmutableList<MqttUserPropertyImpl> asList()

Specified by:

asList in interface Mqtt5UserProperties

Returns:

the User Properties as an immutable list.

encode

public void encode(@NotNull
                   @NotNull io.netty.buffer.ByteBuf out)

Encodes this collection of User Properties to the given byte buffer at the current writer index.

This method does not check if name and value can not be encoded due to byte count restrictions. This check is performed with the method encodedLength() which is generally called before this method.

Parameters:

out - the byte buffer to encode to.

encodedLength

public int encodedLength()

Calculates the byte count of this collection of User Properties according to the MQTT 5 specification.

Returns:

the encoded length of this collection of User Properties.

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

extend

@NotNull
public MqttUserPropertiesImplBuilder.Default extend()

Specified by:

extend in interface Mqtt5UserProperties

Returns:

a builder for extending this collection of User Properties.

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object