com.hivemq.client.internal.mqtt.message.publish.pubcomp

Class MqttPubCompBuilder

java.lang.Object

com.hivemq.client.internal.mqtt.message.publish.pubcomp.MqttPubCompBuilder

All Implemented Interfaces:

Mqtt5PubCompBuilder

public class MqttPubCompBuilder
extends java.lang.Object
implements Mqtt5PubCompBuilder

Constructor Summary

Constructors

Constructor and Description
MqttPubCompBuilder(@NotNull MqttPubRel pubRel)

Method Summary

Modifier and Type	Method and Description
@NotNull MqttPubComp	build()
@NotNull MqttPubRel	getPubRel()
@NotNull Mqtt5PubCompReasonCode	getReasonCode()
@NotNull MqttPubCompBuilder	reasonCode(@NotNull Mqtt5PubCompReasonCode reasonCode)
@NotNull MqttPubCompBuilder	reasonString(@Nullable MqttUtf8String reasonString) Set the optional Reason String.
@NotNull MqttPubCompBuilder	reasonString(@Nullable java.lang.String reasonString) Set the optional Reason String.
MqttUserPropertiesImplBuilder.Nested<MqttPubCompBuilder>	userProperties() Fluent counterpart of Mqtt5PubCompBuilder.userProperties(Mqtt5UserProperties).
@NotNull MqttPubCompBuilder	userProperties(@Nullable Mqtt5UserProperties userProperties) Sets the User Properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttPubCompBuilder

public MqttPubCompBuilder(@NotNull
                          @NotNull MqttPubRel pubRel)

Method Detail

reasonCode

@NotNull
public @NotNull MqttPubCompBuilder reasonCode(@NotNull
                                                       @NotNull Mqtt5PubCompReasonCode reasonCode)

reasonString

@NotNull
public @NotNull MqttPubCompBuilder reasonString(@Nullable
                                                         @Nullable java.lang.String reasonString)

Description copied from interface: Mqtt5PubCompBuilder

Set the optional Reason String.

Specified by:

reasonString in interface Mqtt5PubCompBuilder

Parameters:

reasonString - the Reason String or null to remove any previously set Reason String.

Returns:

the builder.

reasonString

@NotNull
public @NotNull MqttPubCompBuilder reasonString(@Nullable
                                                         @Nullable MqttUtf8String reasonString)

Description copied from interface: Mqtt5PubCompBuilder

Set the optional Reason String.

Specified by:

reasonString in interface Mqtt5PubCompBuilder

Parameters:

reasonString - the Reason String or null to remove any previously set Reason String.

Returns:

the builder.

userProperties

@NotNull
public @NotNull MqttPubCompBuilder userProperties(@Nullable
                                                           @Nullable Mqtt5UserProperties userProperties)

Description copied from interface: Mqtt5PubCompBuilder

Sets the User Properties.

Specified by:

userProperties in interface Mqtt5PubCompBuilder

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@NotNull
public MqttUserPropertiesImplBuilder.Nested<MqttPubCompBuilder> userProperties()

Description copied from interface: Mqtt5PubCompBuilder

Fluent counterpart of Mqtt5PubCompBuilder.userProperties(Mqtt5UserProperties).

Calling Mqtt5UserPropertiesBuilder.Nested#applyUserProperties() on the returned builder has the effect of extending the current User Properties.

Specified by:

userProperties in interface Mqtt5PubCompBuilder

Returns:

the fluent builder for the User Properties.

See Also:

Mqtt5PubCompBuilder.userProperties(Mqtt5UserProperties)

getReasonCode

@NotNull
public @NotNull Mqtt5PubCompReasonCode getReasonCode()

Specified by:

getReasonCode in interface Mqtt5PubCompBuilder

Returns:

the Reason Code of the PubComp message.

getPubRel

@NotNull
public @NotNull MqttPubRel getPubRel()

build

@NotNull
public @NotNull MqttPubComp build()