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

Interface Mqtt5UserPropertiesBuilderBase<B extends Mqtt5UserPropertiesBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt5UserPropertiesBuilder, Mqtt5UserPropertiesBuilder.Nested<P>

@DoNotImplement
public interface Mqtt5UserPropertiesBuilderBase<B extends Mqtt5UserPropertiesBuilderBase<B>>

Builder base for Mqtt5UserProperties.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
B	add(@NotNull MqttUtf8String name, @NotNull MqttUtf8String value)	Adds a User Property.
B	add(@NotNull Mqtt5UserProperty userProperty)	Adds a User Property.
B	add(@NotNull String name, @NotNull String value)	Adds a User Property.
B	addAll(@NotNull Mqtt5UserProperty @NotNull ... userProperties)	Adds User Properties.
B	addAll(@NotNull Collection<@NotNull ? extends Mqtt5UserProperty> userProperties)	Adds a collection of User Properties.
B	addAll(@NotNull Stream<@NotNull ? extends Mqtt5UserProperty> userProperties)	Adds a stream of User Properties.

Method Details

add

@CheckReturnValue
@NotNull
B add(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String value)

Adds a User Property.

Parameters:

name - the name of the User Property.

value - the value of the User Property.

Returns:

the builder.

add

@CheckReturnValue
@NotNull
B add(@NotNull
 @NotNull MqttUtf8String name,
 @NotNull
 @NotNull MqttUtf8String value)

Adds a User Property.

Parameters:

name - the name of the User Property.

value - the value of the User Property.

Returns:

the builder.

add

@CheckReturnValue
@NotNull
B add(@NotNull
 @NotNull Mqtt5UserProperty userProperty)

Adds a User Property.

Parameters:

userProperty - the User Property.

Returns:

the builder.

addAll

@CheckReturnValue
@NotNull
B addAll(@NotNull
 @NotNull Mqtt5UserProperty @NotNull ... userProperties)

Adds User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

Since:

1.2

addAll

@CheckReturnValue
@NotNull
B addAll(@NotNull
 @NotNull Collection<@NotNull ? extends Mqtt5UserProperty> userProperties)

Adds a collection of User Properties.

Parameters:

userProperties - the collection of User Properties.

Returns:

the builder.

Since:

1.2

addAll

@CheckReturnValue
@NotNull
B addAll(@NotNull
 @NotNull Stream<@NotNull ? extends Mqtt5UserProperty> userProperties)

Adds a stream of User Properties.

Parameters:

userProperties - the stream of User Properties.

Returns:

the builder.

Since:

1.2