Package com.hivemq.client.mqtt.mqtt3.message.publish

Interface Mqtt3PublishBuilderBase.Complete<C extends Mqtt3PublishBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Superinterfaces:

Mqtt3PublishBuilderBase<C>

All Known Subinterfaces:

Mqtt3PublishBuilder.Complete, Mqtt3PublishBuilder.Nested.Complete<P>, Mqtt3PublishBuilder.Send.Complete<P>, Mqtt3PublishBuilder.SendVoid.Complete, Mqtt3WillPublishBuilder.Complete, Mqtt3WillPublishBuilder.Nested.Complete<P>

Enclosing interface:

Mqtt3PublishBuilderBase<C extends Mqtt3PublishBuilderBase.Complete<C>>

@DoNotImplement
public static interface Mqtt3PublishBuilderBase.Complete<C extends Mqtt3PublishBuilderBase.Complete<C>>
extends Mqtt3PublishBuilderBase<C>

Mqtt3PublishBuilderBase that is complete which means all mandatory fields are set.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3PublishBuilderBase

Mqtt3PublishBuilderBase.Complete<C extends Mqtt3PublishBuilderBase.Complete<C>>

Method Summary

Modifier and Type	Method	Description
C	payload(byte @Nullable [] payload)	Sets the optional payload.
C	payload(@Nullable ByteBuffer payload)	Sets the optional payload.
C	qos(@NotNull MqttQos qos)	Sets the QoS.
C	retain(boolean retain)	Sets whether the Publish message should be retained.

Methods inherited from interface com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3PublishBuilderBase

topic, topic, topic

Method Details

payload

@CheckReturnValue
@NotNull
C payload(byte @Nullable [] payload)

Sets the optional payload.

Parameters:

payload - the payload as byte array or null to remove any previously set payload.

Returns:

the builder.

payload

@CheckReturnValue
@NotNull
C payload(@Nullable
 @Nullable ByteBuffer payload)

Sets the optional payload.

Parameters:

payload - the payload as ByteBuffer or null to remove any previously set payload.

Returns:

the builder.

qos

@CheckReturnValue
@NotNull
C qos(@NotNull
 @NotNull MqttQos qos)

Sets the QoS.

Parameters:

qos - the QoS.

Returns:

the builder.

retain

@CheckReturnValue
@NotNull
C retain(boolean retain)

Sets whether the Publish message should be retained.

Parameters:

retain - whether the Publish message should be retained.

Returns:

the builder.