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

Interface Mqtt5UserProperties

@DoNotImplement
public interface Mqtt5UserProperties

Collection of User Properties.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@Immutable @NotNull List<@NotNull ? extends Mqtt5UserProperty>	asList()
static @NotNull Mqtt5UserPropertiesBuilder	builder()	Creates a builder for a collection of User Properties.
@NotNull Mqtt5UserPropertiesBuilder	extend()
static @NotNull Mqtt5UserProperties	of()
static @NotNull Mqtt5UserProperties	of(@NotNull Mqtt5UserProperty @NotNull ... userProperties)	Creates a collection of User Properties of individual User Properties.
static @NotNull Mqtt5UserProperties	of(@NotNull Collection<@NotNull Mqtt5UserProperty> userProperties)	Creates a collection of User Properties of a list of User Properties.

Method Details

of

@NotNull
static @NotNull Mqtt5UserProperties of()

Returns:

an empty collection of User Properties.

of

@NotNull
static @NotNull Mqtt5UserProperties of(@NotNull
 @NotNull Mqtt5UserProperty @NotNull ... userProperties)

Creates a collection of User Properties of individual User Properties.

Parameters:

userProperties - the individual User Properties.

Returns:

the created collection of User Properties.

of

@NotNull
static @NotNull Mqtt5UserProperties of(@NotNull
 @NotNull Collection<@NotNull Mqtt5UserProperty> userProperties)

Creates a collection of User Properties of a list of User Properties.

Parameters:

userProperties - the list of User Properties.

Returns:

the created collection of User Properties.

builder

@NotNull
static @NotNull Mqtt5UserPropertiesBuilder builder()

Creates a builder for a collection of User Properties.

Returns:

the created builder for a collection of User Properties.

asList

@NotNull
@Immutable @NotNull List<@NotNull ? extends Mqtt5UserProperty> asList()

Returns:

the User Properties as an immutable list.

extend

@NotNull
@NotNull Mqtt5UserPropertiesBuilder extend()

Returns:

a builder for extending this collection of User Properties.