com.hivemq.client.mqtt.datatypes

Interface MqttTopic

All Superinterfaces:

Comparable<MqttUtf8String>, MqttUtf8String

@DoNotImplement
public interface MqttTopic
extends MqttUtf8String

MQTT Topic Name according to the MQTT specification.

A Topic Name has the same requirements as an UTF-8 encoded string. Additionally it

• must be at least 1 character long and
• must not contain wildcard characters (, ).

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static char	TOPIC_LEVEL_SEPARATOR The topic level separator character.

Method Summary

Modifier and Type	Method and Description
static @NotNull MqttTopicBuilder	builder() Creates a builder for a Topic Name.
MqttTopicBuilder.Complete	extend() Creates a builder for extending this Topic Name.
@NotNull MqttTopicFilter	filter()
@Immutable @NotNull List<String>	getLevels()
static @NotNull MqttTopic	of(@NotNull String string) Validates and creates a Topic Name of the given string.

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

containsShouldNotCharacters, toByteBuffer

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TOPIC_LEVEL_SEPARATOR

static final char TOPIC_LEVEL_SEPARATOR

The topic level separator character.

See Also:

Constant Field Values

Method Detail

of

@NotNull
static @NotNull MqttTopic of(@NotNull
                                      @NotNull String string)

Validates and creates a Topic Name of the given string.

Specified by:

of in interface MqttUtf8String

Parameters:

string - the string representation of the Topic Name.

Returns:

the created Topic Name.

Throws:

IllegalArgumentException - if the string is not a valid Topic Name.

builder

@NotNull
static @NotNull MqttTopicBuilder builder()

Creates a builder for a Topic Name.

Returns:

the created builder.

getLevels

@NotNull
@Immutable @NotNull List<String> getLevels()

Returns:

the levels of this Topic Name.

filter

@NotNull
@NotNull MqttTopicFilter filter()

Returns:

a Topic Filter matching only this Topic Name.

extend

MqttTopicBuilder.Complete extend()

Creates a builder for extending this Topic Name.

Returns:

the created builder.