com.hivemq.client.mqtt.datatypes

Interface MqttTopicBuilder

All Superinterfaces:

MqttTopicBuilderBase<MqttTopicBuilder.Complete>

All Known Subinterfaces:

MqttTopicBuilder.Complete

@DoNotImplement
public interface MqttTopicBuilder
extends MqttTopicBuilderBase<MqttTopicBuilder.Complete>

Builder for a MqttTopic.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MqttTopicBuilder.Complete MqttTopicBuilder that is complete which means all mandatory fields are set.
static interface	MqttTopicBuilder.Nested<P> Builder for a MqttTopic that is applied to a parent.

Method Summary

Modifier and Type	Method and Description
@NotNull MqttTopicFilterBuilder	filter() Creates a builder for a MqttTopicFilter that extends the current Topic Name of this builder.
@NotNull MqttSharedTopicFilterBuilder	share(@NotNull String shareName) Creates a builder for a MqttSharedTopicFilter that extends the current Topic Name of this builder.

Methods inherited from interface com.hivemq.client.mqtt.datatypes.MqttTopicBuilderBase

addLevel

Method Detail

filter

@CheckReturnValue
 @NotNull
@NotNull MqttTopicFilterBuilder filter()

Creates a builder for a MqttTopicFilter that extends the current Topic Name of this builder.

Returns:

the created builder for a Topic Filter.

share

@CheckReturnValue
 @NotNull
@NotNull MqttSharedTopicFilterBuilder share(@NotNull
                                                                        @NotNull String shareName)

Creates a builder for a MqttSharedTopicFilter that extends the current Topic Name of this builder.

Parameters:

shareName - the Share Name.

Returns:

the created builder for a Shared Topic Filter.