Package com.hivemq.client.mqtt.datatypes

Interface MqttTopicFilterBuilderBase<C extends MqttTopicFilterBuilderBase<C,E,S,SC,SE>,E extends MqttTopicFilterBuilderBase.End,S extends MqttTopicFilterBuilderBase.SharedBase<S,SC,SE>,SC extends S,SE extends MqttTopicFilterBuilderBase.End>

Type Parameters:

C - the type of the complete builder.

E - the type of the end builder.

S - the type of the builder for a MqttSharedTopicFilter.

SC - the type of the complete builder for a MqttSharedTopicFilter.

SE - the type of the end builder for a MqttSharedTopicFilter.

All Known Subinterfaces:

MqttSharedTopicFilterBuilder, MqttSharedTopicFilterBuilder.Complete, MqttSharedTopicFilterBuilder.Nested<P>, MqttSharedTopicFilterBuilder.Nested.Complete<P>, MqttTopicFilterBuilder, MqttTopicFilterBuilder.Complete, MqttTopicFilterBuilder.Nested<P>, MqttTopicFilterBuilder.Nested.Complete<P>, MqttTopicFilterBuilderBase.Complete<C,E,S,SC,SE>, MqttTopicFilterBuilderBase.SharedBase<S,SC,SE>, MqttTopicFilterBuilderBase.SharedBase.Complete<S,SC,SE>

@DoNotImplement
public interface MqttTopicFilterBuilderBase<C extends MqttTopicFilterBuilderBase<C,E,S,SC,SE>,E extends MqttTopicFilterBuilderBase.End,S extends MqttTopicFilterBuilderBase.SharedBase<S,SC,SE>,SC extends S,SE extends MqttTopicFilterBuilderBase.End>

Builder base for a MqttTopicFilter.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MqttTopicFilterBuilderBase.Complete<C extends MqttTopicFilterBuilderBase<C,E,S,SC,SE>,E extends MqttTopicFilterBuilderBase.End,S extends MqttTopicFilterBuilderBase.SharedBase<S,SC,SE>,SC extends S,SE extends MqttTopicFilterBuilderBase.End>	MqttTopicFilterBuilderBase that is complete which means all mandatory fields are set.
static interface	MqttTopicFilterBuilderBase.End	End of a MqttTopicFilterBuilderBase that does not allow to add any more levels or wildcards.
static interface	MqttTopicFilterBuilderBase.SharedBase<S extends MqttTopicFilterBuilderBase.SharedBase<S,SC,SE>,SC extends S,SE extends MqttTopicFilterBuilderBase.End>	Builder base for a MqttSharedTopicFilter.

Method Summary

Modifier and Type	Method	Description
C	addLevel(@NotNull String topicLevel)	Adds a Topic level.
E	multiLevelWildcard()	Adds a MqttTopicFilter.MULTI_LEVEL_WILDCARD.
S	share(@NotNull String shareName)	Creates a builder for a MqttSharedTopicFilter that extends the current Topic Filter of this builder.
C	singleLevelWildcard()	Adds a MqttTopicFilter.SINGLE_LEVEL_WILDCARD.

Method Details

addLevel

@CheckReturnValue
@NotNull
C addLevel(@NotNull
 @NotNull String topicLevel)

Adds a Topic level.

Parameters:

topicLevel - the level.

Returns:

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

singleLevelWildcard

@CheckReturnValue
@NotNull
C singleLevelWildcard()

Adds a MqttTopicFilter.SINGLE_LEVEL_WILDCARD.

Returns:

the builder that is now complete as at least one single-level wildcard is set.

multiLevelWildcard

@CheckReturnValue
@NotNull
E multiLevelWildcard()

Adds a MqttTopicFilter.MULTI_LEVEL_WILDCARD.

Returns:

the end builder.

share

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

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

Parameters:

shareName - the Share Name.

Returns:

the created builder for a Shared Topic Filter.