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

Interface Mqtt3SubscribeBuilderBase<C extends Mqtt3SubscribeBuilderBase<C>>

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

Mqtt3AsyncClient.Mqtt3SubscribeAndCallbackBuilder, Mqtt3AsyncClient.Mqtt3SubscribeAndCallbackBuilder.Complete, Mqtt3AsyncClient.Mqtt3SubscribeAndCallbackBuilder.Start, Mqtt3AsyncClient.Mqtt3SubscribeAndCallbackBuilder.Start.Complete, Mqtt3SubscribeBuilder, Mqtt3SubscribeBuilder.Complete, Mqtt3SubscribeBuilder.Nested<P>, Mqtt3SubscribeBuilder.Nested.Complete<P>, Mqtt3SubscribeBuilder.Nested.Start<P>, Mqtt3SubscribeBuilder.Nested.Start.Complete<P>, Mqtt3SubscribeBuilder.Publishes<P>, Mqtt3SubscribeBuilder.Publishes.Complete<P>, Mqtt3SubscribeBuilder.Publishes.Start<P>, Mqtt3SubscribeBuilder.Publishes.Start.Complete<P>, Mqtt3SubscribeBuilder.Send<P>, Mqtt3SubscribeBuilder.Send.Complete<P>, Mqtt3SubscribeBuilder.Send.Start<P>, Mqtt3SubscribeBuilder.Send.Start.Complete<P>, Mqtt3SubscribeBuilder.Start, Mqtt3SubscribeBuilder.Start.Complete, Mqtt3SubscribeBuilderBase.Start<C,SC>, Mqtt3SubscribeBuilderBase.Start.Complete<C,SC>

@DoNotImplement
public interface Mqtt3SubscribeBuilderBase<C extends Mqtt3SubscribeBuilderBase<C>>

Builder base for a Mqtt3Subscribe.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Mqtt3SubscribeBuilderBase.Start<C extends Mqtt3SubscribeBuilderBase<C>,SC extends Mqtt3SubscribeBuilderBase.Start.Complete<C,SC>>	Mqtt3SubscribeBuilderBase that provides additional methods for the first subscription.

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt3SubscriptionBuilder.Nested<? extends C>	addSubscription()	Fluent counterpart of addSubscription(Mqtt3Subscription).
C	addSubscription(@NotNull Mqtt3Subscription subscription)	Adds a Mqtt3Subscription to the list of subscriptions.
C	addSubscriptions(@NotNull Mqtt3Subscription @NotNull ... subscriptions)	Adds Mqtt3Subscriptions to the list of subscriptions.
C	addSubscriptions(@NotNull Collection<@NotNull ? extends Mqtt3Subscription> subscriptions)	Adds a collection of Mqtt3Subscriptions to the list of subscriptions.
C	addSubscriptions(@NotNull Stream<@NotNull ? extends Mqtt3Subscription> subscriptions)	Adds a stream of Mqtt3Subscriptions to the list of subscriptions.

Method Details

addSubscription

@CheckReturnValue
@NotNull
C addSubscription(@NotNull
 @NotNull Mqtt3Subscription subscription)

Adds a Mqtt3Subscription 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

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

Fluent counterpart of addSubscription(Mqtt3Subscription).

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

Returns:

the fluent builder for the subscription.

See Also:

• addSubscription(Mqtt3Subscription)

addSubscriptions

@CheckReturnValue
@NotNull
C addSubscriptions(@NotNull
 @NotNull Mqtt3Subscription @NotNull ... subscriptions)

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

Parameters:

subscriptions - the subscriptions.

Returns:

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

Since:

1.2

addSubscriptions

@CheckReturnValue
@NotNull
C addSubscriptions(@NotNull
 @NotNull Collection<@NotNull ? extends Mqtt3Subscription> subscriptions)

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

Parameters:

subscriptions - the collection of subscriptions.

Returns:

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

Since:

1.2

addSubscriptions

@CheckReturnValue
@NotNull
C addSubscriptions(@NotNull
 @NotNull Stream<@NotNull ? extends Mqtt3Subscription> subscriptions)

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

Parameters:

subscriptions - the stream of subscriptions.

Returns:

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

Since:

1.2