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

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

Type Parameters:

C - the type of the complete builder.

All Known Subinterfaces:

Mqtt5UnsubscribeBuilder, Mqtt5UnsubscribeBuilder.Complete, Mqtt5UnsubscribeBuilder.Nested<P>, Mqtt5UnsubscribeBuilder.Nested.Complete<P>, Mqtt5UnsubscribeBuilder.Nested.Start<P>, Mqtt5UnsubscribeBuilder.Send<P>, Mqtt5UnsubscribeBuilder.Send.Complete<P>, Mqtt5UnsubscribeBuilder.Send.Start<P>, Mqtt5UnsubscribeBuilder.Start, Mqtt5UnsubscribeBuilderBase.Complete<C>, Mqtt5UnsubscribeBuilderBase.Start<C>

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

Builder base for a Mqtt5Unsubscribe.

Since:

1.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
@NotNull 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 String topicFilter)	Adds a Topic Filter to the list of Topic Filters.
C	addTopicFilters(@NotNull MqttTopicFilter @NotNull ... topicFilters)	Adds Topic Filters to the list of Topic Filters.
C	addTopicFilters(@NotNull Collection<@NotNull ? extends MqttTopicFilter> topicFilters)	Adds a collection of Topic Filters to the list of Topic Filters.
C	addTopicFilters(@NotNull Stream<@NotNull ? extends MqttTopicFilter> topicFilters)	Adds a stream of Topic Filters to the list of Topic Filters.
C	reverse(@NotNull Mqtt5Subscribe subscribe)	Reverses the subscriptions of a Subscribe message by adding their Topic Filters.

Method Details

addTopicFilter

@CheckReturnValue
@NotNull
C addTopicFilter(@NotNull
 @NotNull 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

@CheckReturnValue
@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

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

Fluent counterpart of addTopicFilter(MqttTopicFilter).

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

Returns:

the fluent builder for the Topic Filter.

See Also:

• addTopicFilter(MqttTopicFilter)

addTopicFilters

@CheckReturnValue
@NotNull
C addTopicFilters(@NotNull
 @NotNull MqttTopicFilter @NotNull ... topicFilters)

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

Parameters:

topicFilters - the Topic Filters.

Returns:

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

Since:

1.2

addTopicFilters

@CheckReturnValue
@NotNull
C addTopicFilters(@NotNull
 @NotNull Collection<@NotNull ? extends MqttTopicFilter> topicFilters)

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

Parameters:

topicFilters - the collection of Topic Filters.

Returns:

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

Since:

1.2

addTopicFilters

@CheckReturnValue
@NotNull
C addTopicFilters(@NotNull
 @NotNull Stream<@NotNull ? extends MqttTopicFilter> topicFilters)

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

Parameters:

topicFilters - the stream of Topic Filters.

Returns:

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

Since:

1.2

reverse

@CheckReturnValue
@NotNull
C reverse(@NotNull
 @NotNull Mqtt5Subscribe 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.