Package org.eclipse.ditto.protocoladapter

Interface TopicPath

public interface TopicPath

Represents the path of a topic for the Ditto Protocol.

A TopicPath complies with the scheme <namespace>/<id>/<group>/<channel>/<criterion>/<action>
for example org.eclipse.ditto/myThing/things/twin/commands/modify

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TopicPath.Action	An enumeration of topic path actions.
static class	TopicPath.Channel	An enumeration of topic path channel.
static class	TopicPath.Criterion	An enumeration of topic path criteria.
static class	TopicPath.Group	An enumeration of topic path groups.
static class	TopicPath.SearchAction	An enumeration of topic path search-actions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID_PLACEHOLDER
static String	PATH_DELIMITER

Method Summary

Modifier and Type	Method	Description
static TopicPathBuilder	fromNamespace(String namespace)	Returns a mutable builder to create immutable TopicPath instances for a given namespace.
Optional<TopicPath.Action>	getAction()	Returns an Optional for an action part of this TopicPath.
TopicPath.Channel	getChannel()	Returns the channel part of this TopicPath.
TopicPath.Criterion	getCriterion()	Returns the criterion part of this TopicPath.
TopicPath.Group	getGroup()	Returns the group part of this TopicPath.
String	getId()	Returns the id part of this TopicPath.
String	getNamespace()	Returns the namespace part of this TopicPath.
String	getPath()	Returns the path of this TopicPath.
Optional<TopicPath.SearchAction>	getSearchAction()	Returns an Optional for an search action part of this TopicPath.
Optional<String>	getSubject()	Returns an Optional for a subject part of this TopicPath.
default boolean	isWildcardTopic()
static TopicPathBuilder	newBuilder(String thingId)	Deprecated. Thing ID is now typed.
static TopicPathBuilder	newBuilder(org.eclipse.ditto.model.policies.PolicyId policyId)	Returns a mutable builder to create immutable TopicPath instances for a given policyId.
static TopicPathBuilder	newBuilder(org.eclipse.ditto.model.things.ThingId thingId)	Returns a mutable builder to create immutable TopicPath instances for a given thingId.

Field Detail

ID_PLACEHOLDER

static final String ID_PLACEHOLDER

See Also:

Constant Field Values

PATH_DELIMITER

static final String PATH_DELIMITER

See Also:

Constant Field Values

Method Detail

newBuilder

@Deprecated
static TopicPathBuilder newBuilder(String thingId)

Deprecated.

Thing ID is now typed. Use newBuilder(org.eclipse.ditto.model.things.ThingId) instead.

Returns a mutable builder to create immutable TopicPath instances for a given thingId.

Parameters:

thingId - the identifier of the Thing.

Returns:

the builder.

Throws:

NullPointerException - if thingId is null.

newBuilder

static TopicPathBuilder newBuilder(org.eclipse.ditto.model.things.ThingId thingId)

Returns a mutable builder to create immutable TopicPath instances for a given thingId.

Parameters:

thingId - the identifier of the Thing.

Returns:

the builder.

Throws:

NullPointerException - if thingId is null.

newBuilder

static TopicPathBuilder newBuilder(org.eclipse.ditto.model.policies.PolicyId policyId)

Returns a mutable builder to create immutable TopicPath instances for a given policyId.

Parameters:

policyId - the identifier of the Policy.

Returns:

the builder.

Throws:

NullPointerException - if policyId is null.

fromNamespace

static TopicPathBuilder fromNamespace(String namespace)

Returns a mutable builder to create immutable TopicPath instances for a given namespace.

Parameters:

namespace - the namespace.

Returns:

the builder.

Throws:

NullPointerException - if namespace is null.

getNamespace

String getNamespace()

Returns the namespace part of this TopicPath.

Returns:

the namespace.

getGroup

TopicPath.Group getGroup()

Returns the group part of this TopicPath.

Returns:

the group.

getChannel

TopicPath.Channel getChannel()

Returns the channel part of this TopicPath.

Returns:

the channel.

getCriterion

TopicPath.Criterion getCriterion()

Returns the criterion part of this TopicPath.

Returns:

the criterion.

getAction

Optional<TopicPath.Action> getAction()

Returns an Optional for an action part of this TopicPath.

Returns:

the action.

getSearchAction

Optional<TopicPath.SearchAction> getSearchAction()

Returns an Optional for an search action part of this TopicPath.

Returns:

the search action.

getSubject

Optional<String> getSubject()

Returns an Optional for a subject part of this TopicPath.

Returns:

the subject.

getId

String getId()

Returns the id part of this TopicPath.

Returns:

the id.

getPath

String getPath()

Returns the path of this TopicPath.

Returns:

the path.

isWildcardTopic

default boolean isWildcardTopic()