com.hivemq.client.mqtt.mqtt5.message.unsubscribe

Interface Mqtt5UnsubscribeBuilderBase.Start<C extends Mqtt5UnsubscribeBuilderBase.Complete<C>>

Type Parameters:

C - the type of the complete builder.

All Superinterfaces:

Mqtt5UnsubscribeBuilderBase<C>

All Known Subinterfaces:

Mqtt5UnsubscribeBuilder.Nested.Start<P>, Mqtt5UnsubscribeBuilder.Send.Start<P>, Mqtt5UnsubscribeBuilder.Start

Enclosing interface:

Mqtt5UnsubscribeBuilderBase<C extends Mqtt5UnsubscribeBuilderBase.Complete<C>>

@DoNotImplement
public static interface Mqtt5UnsubscribeBuilderBase.Start<C extends Mqtt5UnsubscribeBuilderBase.Complete<C>>
extends Mqtt5UnsubscribeBuilderBase<C>

Mqtt5UnsubscribeBuilderBase that provides additional methods for the first Topic Filter.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.message.unsubscribe.Mqtt5UnsubscribeBuilderBase

Mqtt5UnsubscribeBuilderBase.Complete<C extends Mqtt5UnsubscribeBuilderBase.Complete<C>>, Mqtt5UnsubscribeBuilderBase.Start<C extends Mqtt5UnsubscribeBuilderBase.Complete<C>>

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 first Topic Filter.
C	topicFilter(@NotNull String topicFilter) Sets the mandatory first Topic Filter.

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.unsubscribe.Mqtt5UnsubscribeBuilderBase

addTopicFilter, addTopicFilter, addTopicFilter, addTopicFilters, addTopicFilters, addTopicFilters, reverse

Method Detail

topicFilter

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

Sets the mandatory first 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 first 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:

Mqtt5UnsubscribeBuilderBase.addTopicFilter(MqttTopicFilter)