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

Interface Mqtt5SubscriptionBuilderBase<C extends Mqtt5SubscriptionBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

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

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

Builder base for a Mqtt5Subscription.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mqtt5SubscriptionBuilderBase.Complete<C extends Mqtt5SubscriptionBuilderBase.Complete<C>> Mqtt5SubscriptionBuilderBase that is complete which means all mandatory fields are set.

Method Summary

Modifier and Type	Method and Description
MqttTopicFilterBuilder.Nested<? extends C>	topicFilter() Fluent counterpart of topicFilter(MqttTopicFilter).
C	topicFilter(@NotNull MqttTopicFilter topicFilter) Sets the mandatory Topic Filter.
C	topicFilter(@NotNull String topicFilter) Sets the mandatory Topic Filter.

Method Detail

topicFilter

@CheckReturnValue
 @NotNull
C topicFilter(@NotNull
                                          @NotNull String topicFilter)

Sets the mandatory Topic Filter.

Parameters:

topicFilter - the string representation of the Topic Filter.

Returns:

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

topicFilter

@CheckReturnValue
 @NotNull
C topicFilter(@NotNull
                                          @NotNull MqttTopicFilter topicFilter)

Sets the mandatory Topic Filter.

Parameters:

topicFilter - the Topic Filter.

Returns:

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

topicFilter

@CheckReturnValue
MqttTopicFilterBuilder.Nested<? extends C> topicFilter()

Fluent counterpart of topicFilter(MqttTopicFilter).

Calling MqttTopicFilterBuilder.Nested.Complete#applyTopicFilter() on the returned builder has the same effect as calling topicFilter(MqttTopicFilter) with the result of MqttTopicFilterBuilder.Complete#build().

Returns:

the fluent builder for the Topic Filter.

See Also:

topicFilter(MqttTopicFilter)