Package energy.eddie.regionconnector.aiida.mqtt.topic

Record Class MqttTopic

java.lang.Object

java.lang.Record

energy.eddie.regionconnector.aiida.mqtt.topic.MqttTopic

public record MqttTopic(String prefix, String permissionId, MqttTopicType topicType)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PREFIX
static final String	DELIMITER
static final int	DELIMITER_LENGTH
static final int	MESSAGE_VERSION_LENGTH
static final int	PERMISSION_ID_LENGTH

Constructor Summary

Constructors

Constructor	Description
MqttTopic(String prefix, String permissionId, MqttTopicType topicType)	Creates an instance of a MqttTopic record class.

Method Summary

Modifier and Type	Method	Description
MqttAcl	aiidaAcl(String username)
String	aiidaTopic()
String	baseTopic()
String	eddieTopic()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static MqttTopic	of(String permissionId, MqttTopicType topicType)
String	permissionId()	Returns the value of the permissionId record component.
String	prefix()	Returns the value of the prefix record component.
String	schemaTopic(AiidaSchema schema)
MqttTopicType	topicType()	Returns the value of the topicType record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

public static final String DELIMITER

See Also:

• Constant Field Values

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

See Also:

• Constant Field Values

MESSAGE_VERSION_LENGTH

public static final int MESSAGE_VERSION_LENGTH

PERMISSION_ID_LENGTH

public static final int PERMISSION_ID_LENGTH

See Also:

• Constant Field Values

DELIMITER_LENGTH

public static final int DELIMITER_LENGTH

Constructor Details

MqttTopic

public MqttTopic(String prefix,
 String permissionId,
 MqttTopicType topicType)

Creates an instance of a MqttTopic record class.

Parameters:

prefix - the value for the prefix record component

permissionId - the value for the permissionId record component

topicType - the value for the topicType record component

Method Details

of

public static MqttTopic of(String permissionId,
 MqttTopicType topicType)

eddieTopic

public String eddieTopic()

aiidaTopic

public String aiidaTopic()

baseTopic

public String baseTopic()

schemaTopic

public String schemaTopic(AiidaSchema schema)

aiidaAcl

public MqttAcl aiidaAcl(String username)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

prefix

public String prefix()

Returns the value of the prefix record component.

Returns:

the value of the prefix record component

permissionId

public String permissionId()

Returns the value of the permissionId record component.

Returns:

the value of the permissionId record component

topicType

public MqttTopicType topicType()

Returns the value of the topicType record component.

Returns:

the value of the topicType record component