com.hivemq.client.mqtt.mqtt3.message.unsubscribe

Interface Mqtt3UnsubscribeBuilderBase<C extends Mqtt3UnsubscribeBuilderBase<C>>

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

Mqtt3UnsubscribeBuilder, Mqtt3UnsubscribeBuilder.Complete, Mqtt3UnsubscribeBuilder.Nested<P>, Mqtt3UnsubscribeBuilder.Nested.Complete<P>, Mqtt3UnsubscribeBuilder.Nested.Start<P>, Mqtt3UnsubscribeBuilder.Send<P>, Mqtt3UnsubscribeBuilder.Send.Complete<P>, Mqtt3UnsubscribeBuilder.Send.Start<P>, Mqtt3UnsubscribeBuilder.SendVoid, Mqtt3UnsubscribeBuilder.SendVoid.Complete, Mqtt3UnsubscribeBuilder.SendVoid.Start, Mqtt3UnsubscribeBuilder.Start, Mqtt3UnsubscribeBuilderBase.Start<C>

All Known Implementing Classes:

Mqtt3UnsubscribeViewBuilder.Default, Mqtt3UnsubscribeViewBuilder.Nested, Mqtt3UnsubscribeViewBuilder.Send, Mqtt3UnsubscribeViewBuilder.SendVoid

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

Builder base for a Mqtt3Unsubscribe.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mqtt3UnsubscribeBuilderBase.Start<C extends Mqtt3UnsubscribeBuilderBase<C>> Mqtt3UnsubscribeBuilderBase that provides additional methods for the first Topic Filter.

Method Summary

Modifier and Type	Method and Description
MqttTopicFilterBuilder.Nested<? extends C>	addTopicFilter() Fluent counterpart of addTopicFilter(MqttTopicFilter).
C	addTopicFilter(@NotNull MqttTopicFilter topicFilter) Adds a Topic Filter to the list of Topic Filters.
C	addTopicFilter(@NotNull java.lang.String topicFilter) Adds a Topic Filter to the list of Topic Filters.
C	reverse(@NotNull Mqtt3Subscribe subscribe) Reverses the subscriptions of a Subscribe message by adding their Topic Filters.

Method Detail

addTopicFilter

@NotNull
C addTopicFilter(@NotNull
                          @NotNull java.lang.String topicFilter)

Adds a Topic Filter to the list of Topic Filters. At least one Topic Filter is mandatory.

Parameters:

topicFilter - the string representation of the Topic Filter.

Returns:

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

addTopicFilter

@NotNull
C addTopicFilter(@NotNull
                          @NotNull MqttTopicFilter topicFilter)

Adds a Topic Filter to the list of Topic Filters. At least one Topic Filter is mandatory.

Parameters:

topicFilter - the Topic Filter.

Returns:

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

addTopicFilter

@NotNull
MqttTopicFilterBuilder.Nested<? extends C> addTopicFilter()

Fluent counterpart of addTopicFilter(MqttTopicFilter).

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

Returns:

the fluent builder for the Topic Filter.

See Also:

addTopicFilter(MqttTopicFilter)

reverse

@NotNull
C reverse(@NotNull
                   @NotNull Mqtt3Subscribe subscribe)

Reverses the subscriptions of a Subscribe message by adding their Topic Filters.

Parameters:

subscribe - the Subscribe message.

Returns:

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