com.hivemq.client.mqtt.mqtt5.message.publish

Interface Mqtt5PublishBuilderBase.Complete<C extends Mqtt5PublishBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Superinterfaces:

Mqtt5PublishBuilderBase<C>

All Known Subinterfaces:

Mqtt5PublishBuilder.Complete, Mqtt5PublishBuilder.Nested.Complete<P>, Mqtt5PublishBuilder.Send.Complete<P>, Mqtt5PublishBuilderBase.WillBase.Complete<C>, Mqtt5WillPublishBuilder.Complete, Mqtt5WillPublishBuilder.Nested.Complete<P>

Enclosing interface:

Mqtt5PublishBuilderBase<C extends Mqtt5PublishBuilderBase.Complete<C>>

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

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5PublishBuilderBase

Mqtt5PublishBuilderBase.Complete<C extends Mqtt5PublishBuilderBase.Complete<C>>, Mqtt5PublishBuilderBase.WillBase<C extends Mqtt5PublishBuilderBase.WillBase.Complete<C>>

Method Summary

Modifier and Type	Method and Description
C	contentType(@Nullable MqttUtf8String contentType) Sets the optional content type.
C	contentType(@Nullable String contentType) Sets the optional content type.
C	correlationData(byte[] correlationData) Sets the optional correlation data.
C	correlationData(@Nullable ByteBuffer correlationData) Sets the optional correlation data.
C	messageExpiryInterval(long messageExpiryInterval) Sets the message expiry interval in seconds.
C	noMessageExpiry() Disables the message expiry.
C	payload(byte[] payload) Sets the optional payload.
C	payload(@Nullable ByteBuffer payload) Sets the optional payload.
C	payloadFormatIndicator(@Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator) Sets the optional payload format indicator.
C	qos(@NotNull MqttQos qos) Sets the QoS.
MqttTopicBuilder.Nested<? extends C>	responseTopic() Fluent counterpart of responseTopic(MqttTopic).
C	responseTopic(@Nullable MqttTopic responseTopic) Sets the optional response topic.
C	responseTopic(@Nullable String responseTopic) Sets the optional response topic.
C	retain(boolean retain) Sets whether the Publish message should be retained.
Mqtt5UserPropertiesBuilder.Nested<? extends C>	userProperties() Fluent counterpart of userProperties(Mqtt5UserProperties).
C	userProperties(@NotNull Mqtt5UserProperties userProperties) Sets the User Properties.

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5PublishBuilderBase

topic, topic, topic

Method Detail

payload

@CheckReturnValue
 @NotNull
C payload(byte[] 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.

messageExpiryInterval

@CheckReturnValue
 @NotNull
C messageExpiryInterval(long messageExpiryInterval)

Sets the message expiry interval in seconds.

The value must be in the range of an unsigned int: [0, 4_294_967_295].

Parameters:

messageExpiryInterval - the message expiry interval in seconds.

Returns:

the builder.

noMessageExpiry

@CheckReturnValue
 @NotNull
C noMessageExpiry()

Disables the message expiry.

Returns:

the builder.

payloadFormatIndicator

@CheckReturnValue
 @NotNull
C payloadFormatIndicator(@Nullable
                                                     @Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator)

Sets the optional payload format indicator.

Parameters:

payloadFormatIndicator - the payload format indicator or null to remove any previously set payload format indicator.

Returns:

the builder.

contentType

@CheckReturnValue
 @NotNull
C contentType(@Nullable
                                          @Nullable String contentType)

Sets the optional content type.

Parameters:

contentType - the content type or null to remove any previously set content type.

Returns:

the builder.

contentType

@CheckReturnValue
 @NotNull
C contentType(@Nullable
                                          @Nullable MqttUtf8String contentType)

Sets the optional content type.

Parameters:

contentType - the content type or null to remove any previously set content type.

Returns:

the builder.

responseTopic

@CheckReturnValue
 @NotNull
C responseTopic(@Nullable
                                            @Nullable String responseTopic)

Sets the optional response topic.

Parameters:

responseTopic - the response topic or null to remove any previously set response topic.

Returns:

the builder.

responseTopic

@CheckReturnValue
 @NotNull
C responseTopic(@Nullable
                                            @Nullable MqttTopic responseTopic)

Sets the optional response topic.

Parameters:

responseTopic - the response topic or null to remove any previously set response topic.

Returns:

the builder.

responseTopic

@CheckReturnValue
MqttTopicBuilder.Nested<? extends C> responseTopic()

Fluent counterpart of responseTopic(MqttTopic).

Calling MqttTopicBuilder.Nested.Complete#applyTopic() on the returned builder has the same effect as calling responseTopic(MqttTopic) with the result of MqttTopicBuilder.Complete#build().

Returns:

the fluent builder for the response topic.

See Also:

responseTopic(MqttTopic)

correlationData

@CheckReturnValue
 @NotNull
C correlationData(byte[] correlationData)

Sets the optional correlation data.

Parameters:

correlationData - the correlation data as byte array or null to remove any previously set correlation data.

Returns:

the builder.

correlationData

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

Sets the optional correlation data.

Parameters:

correlationData - the correlation data as ByteBuffer or null to remove any previously set correlation data.

Returns:

the builder.

userProperties

@CheckReturnValue
 @NotNull
C userProperties(@NotNull
                                             @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
Mqtt5UserPropertiesBuilder.Nested<? extends C> userProperties()

Fluent counterpart of userProperties(Mqtt5UserProperties).

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

Returns:

the fluent builder for the User Properties.

See Also:

userProperties(Mqtt5UserProperties)