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

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

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

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

All Known Implementing Classes:

MqttPublishBuilder.Default, MqttPublishBuilder.Nested, MqttPublishBuilder.Send, MqttPublishBuilder.WillDefault, MqttPublishBuilder.WillNested

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

Builder base for a Mqtt5Publish.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mqtt5PublishBuilderBase.Complete<C extends Mqtt5PublishBuilderBase.Complete<C>> Mqtt5PublishBuilderBase that is complete which means all mandatory fields are set.
static interface	Mqtt5PublishBuilderBase.WillBase<C extends Mqtt5PublishBuilderBase.WillBase.Complete<C>> Builder base for a Mqtt5WillPublish.

Method Summary

Modifier and Type	Method and Description
MqttTopicBuilder.Nested<? extends C>	topic() Fluent counterpart of topic(MqttTopic).
C	topic(@NotNull MqttTopic topic) Sets the mandatory Topic.
C	topic(@NotNull java.lang.String topic) Sets the mandatory Topic.

Method Detail

topic

@NotNull
C topic(@NotNull
                 @NotNull java.lang.String topic)

Sets the mandatory Topic.

Parameters:

topic - the string representation of the Topic.

Returns:

the builder that is now complete as the mandatory Topic is set.

topic

@NotNull
C topic(@NotNull
                 @NotNull MqttTopic topic)

Sets the mandatory Topic.

Parameters:

topic - the Topic.

Returns:

the builder that is now complete as the mandatory Topic is set.

topic

@NotNull
MqttTopicBuilder.Nested<? extends C> topic()

Fluent counterpart of topic(MqttTopic).

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

Returns:

the fluent builder for the Topic.

See Also:

topic(MqttTopic)