Package software.amazon.smithy.mqtt.traits

Class Topic

java.lang.Object

software.amazon.smithy.mqtt.traits.Topic

public final class Topic
extends Object

Represents a parsed MQTT topic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Topic.Level	Represents a level in a topic.
static enum	Topic.TopicRule	Controls the rules for how a value is parsed into a topic.

Method Summary

Modifier and Type	Method	Description
boolean	conflictsWith(Topic other)	Determines if this topic conflicts with another topic.
boolean	equals(Object o)
List<Topic.Level>	getLabels()	Gets all of the label levels in the topic.
List<Topic.Level>	getLevels()	Gets all of the hierarchical levels of the topic.
int	hashCode()
boolean	hasLabel(String label)	Returns true if the topic contains the given label string.
static Topic	parse(String topic)	Parses a string into an MQTT topic, including substitution labels.
static Topic	parse(Topic.TopicRule rule, String topic)	Parses a string into an MQTT topic, including substitution labels.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

parse

public static Topic parse(String topic)

Parses a string into an MQTT topic, including substitution labels.

Parameters:

topic - string to parse into a modeled MQTT topic

Returns:

Returns the parsed topic.

Throws:

TopicSyntaxException - if the topic is malformed.

parse

public static Topic parse(Topic.TopicRule rule,
 String topic)

Parses a string into an MQTT topic, including substitution labels.

Parameters:

rule - MQTT-specific rule to apply to the parsing

topic - string to parse into a modeled MQTT topic

Returns:

Returns the parsed topic.

Throws:

TopicSyntaxException - if the topic is malformed.

getLevels

public List<Topic.Level> getLevels()

Gets all of the hierarchical levels of the topic.

Returns:

Returns the topic levels.

getLabels

public List<Topic.Level> getLabels()

Gets all of the label levels in the topic.

Returns:

Returns the label levels.

hasLabel

public boolean hasLabel(String label)

Returns true if the topic contains the given label string.

Parameters:

label - Label to check for.

Returns:

Returns true if the label exists in the topic.

conflictsWith

public boolean conflictsWith(Topic other)

Determines if this topic conflicts with another topic.

Parameters:

other - Topic to check against.

Returns:

Returns true if there is a conflict.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object