com.hivemq.client.mqtt.mqtt5.message.subscribe

Interface Mqtt5SubscribeBuilderBase<C extends Mqtt5SubscribeBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder, Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Complete, Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Start, Mqtt5AsyncClient.Mqtt5SubscribeAndCallbackBuilder.Start.Complete, Mqtt5SubscribeBuilder, Mqtt5SubscribeBuilder.Complete, Mqtt5SubscribeBuilder.Nested<P>, Mqtt5SubscribeBuilder.Nested.Complete<P>, Mqtt5SubscribeBuilder.Nested.Start<P>, Mqtt5SubscribeBuilder.Nested.Start.Complete<P>, Mqtt5SubscribeBuilder.Send<P>, Mqtt5SubscribeBuilder.Send.Complete<P>, Mqtt5SubscribeBuilder.Send.Start<P>, Mqtt5SubscribeBuilder.Send.Start.Complete<P>, Mqtt5SubscribeBuilder.Start, Mqtt5SubscribeBuilder.Start.Complete, Mqtt5SubscribeBuilderBase.Complete<C>, Mqtt5SubscribeBuilderBase.Start<C,SC>, Mqtt5SubscribeBuilderBase.Start.Complete<C,SC>

All Known Implementing Classes:

MqttAsyncClient.MqttSubscribeAndCallbackBuilder, MqttSubscribeBuilder.Default, MqttSubscribeBuilder.Nested, MqttSubscribeBuilder.Send

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

Builder base for a Mqtt5Subscribe.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mqtt5SubscribeBuilderBase.Complete<C extends Mqtt5SubscribeBuilderBase.Complete<C>> Mqtt5SubscribeBuilderBase that is complete which means all mandatory fields are set.
static interface	Mqtt5SubscribeBuilderBase.Start<C extends Mqtt5SubscribeBuilderBase.Complete<C>,SC extends Mqtt5SubscribeBuilderBase.Start.Complete<C,SC>> Mqtt5SubscribeBuilderBase that provides additional methods for the first subscription.

Method Summary

Modifier and Type	Method and Description
Mqtt5SubscriptionBuilder.Nested<? extends C>	addSubscription() Fluent counterpart of addSubscription(Mqtt5Subscription).
C	addSubscription(@NotNull Mqtt5Subscription subscription) Adds a Mqtt5Subscription to the list of subscriptions.

Method Detail

addSubscription

@NotNull
C addSubscription(@NotNull
                           @NotNull Mqtt5Subscription subscription)

Adds a Mqtt5Subscription to the list of subscriptions. At least one subscription is mandatory.

Parameters:

subscription - the subscription.

Returns:

the builder that is now complete as at least one subscription is set.

addSubscription

@NotNull
Mqtt5SubscriptionBuilder.Nested<? extends C> addSubscription()

Fluent counterpart of addSubscription(Mqtt5Subscription).

Calling Mqtt5SubscriptionBuilder.Nested.Complete.applySubscription() on the returned builder has the same effect as calling addSubscription(Mqtt5Subscription) with the result of Mqtt5SubscriptionBuilder.Complete.build().

Returns:

the fluent builder for the subscription.

See Also:

addSubscription(Mqtt5Subscription)