com.hivemq.client.internal.mqtt.message.publish

Class MqttWillPublish

java.lang.Object

com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

com.hivemq.client.internal.mqtt.message.publish.MqttPublish

com.hivemq.client.internal.mqtt.message.publish.MqttWillPublish

All Implemented Interfaces:

MqttMessage, MqttMessage.WithUserProperties, Mqtt5Message, Mqtt5Publish, Mqtt5WillPublish

@Immutable
public class MqttWillPublish
extends MqttPublish
implements Mqtt5WillPublish

Nested Class Summary

Nested classes/interfaces inherited from class com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

MqttMessageWithUserProperties.WithReason

Nested classes/interfaces inherited from interface com.hivemq.client.internal.mqtt.message.MqttMessage

MqttMessage.WithId, MqttMessage.WithUserProperties

Field Summary

Fields inherited from class com.hivemq.client.internal.mqtt.message.publish.MqttPublish

NO_MESSAGE_EXPIRY

Fields inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5WillPublish

DEFAULT_DELAY_INTERVAL

Fields inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

DEFAULT_QOS

Constructor Summary

Constructors

Constructor and Description

MqttWillPublish(@NotNull MqttTopicImpl topic, @Nullable java.nio.ByteBuffer payload, @NotNull MqttQos qos, boolean isRetain, long messageExpiryInterval, @Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator, @Nullable MqttUtf8StringImpl contentType, @Nullable MqttTopicImpl responseTopic, @Nullable java.nio.ByteBuffer correlationData, @NotNull MqttUserPropertiesImpl userProperties, long delayInterval)

Method Summary

Modifier and Type	Method and Description
@NotNull MqttWillPublish	asWill() Transforms this Publish message into a Will Publish with the same properties.
protected boolean	canEqual(@Nullable java.lang.Object o)
boolean	equals(@Nullable java.lang.Object o)
MqttPublishBuilder.WillDefault	extendAsWill() Creates a builder for extending this Will Publish.
long	getDelayInterval()
int	hashCode()
protected @NotNull java.lang.String	toAttributeString()
@NotNull java.lang.String	toString()

Methods inherited from class com.hivemq.client.internal.mqtt.message.publish.MqttPublish

createStateful, createStateful, extend, getContentType, getCorrelationData, getMessageExpiryInterval, getPayload, getPayloadAsBytes, getPayloadFormatIndicator, getQos, getRawContentType, getRawCorrelationData, getRawMessageExpiryInterval, getRawPayload, getRawPayloadFormatIndicator, getRawResponseTopic, getResponseTopic, getTopic, isRetain

Methods inherited from class com.hivemq.client.internal.mqtt.message.MqttMessageWithUserProperties

getUserProperties, partialEquals, partialHashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5WillPublish

builder

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5Publish

extend, getContentType, getCorrelationData, getMessageExpiryInterval, getPayload, getPayloadAsBytes, getPayloadFormatIndicator, getQos, getResponseTopic, getTopic, getType, getUserProperties, isRetain

Constructor Detail

MqttWillPublish

public MqttWillPublish(@NotNull
                       @NotNull MqttTopicImpl topic,
                       @Nullable
                       @Nullable java.nio.ByteBuffer payload,
                       @NotNull
                       @NotNull MqttQos qos,
                       boolean isRetain,
                       long messageExpiryInterval,
                       @Nullable
                       @Nullable Mqtt5PayloadFormatIndicator payloadFormatIndicator,
                       @Nullable
                       @Nullable MqttUtf8StringImpl contentType,
                       @Nullable
                       @Nullable MqttTopicImpl responseTopic,
                       @Nullable
                       @Nullable java.nio.ByteBuffer correlationData,
                       @NotNull
                       @NotNull MqttUserPropertiesImpl userProperties,
                       long delayInterval)

Method Detail

getDelayInterval

public long getDelayInterval()

Specified by:

getDelayInterval in interface Mqtt5WillPublish

Returns:

the delay of this Will Publish. The default is Mqtt5WillPublish.DEFAULT_DELAY_INTERVAL.

asWill

@NotNull
public @NotNull MqttWillPublish asWill()

Description copied from interface: Mqtt5Publish

Transforms this Publish message into a Will Publish with the same properties.

Specified by:

asWill in interface Mqtt5Publish

Overrides:

asWill in class MqttPublish

Returns:

the Will Publish.

extendAsWill

@NotNull
public MqttPublishBuilder.WillDefault extendAsWill()

Description copied from interface: Mqtt5WillPublish

Creates a builder for extending this Will Publish.

Specified by:

extendAsWill in interface Mqtt5WillPublish

Returns:

the created builder.

toAttributeString

@NotNull
protected @NotNull java.lang.String toAttributeString()

Overrides:

toAttributeString in class MqttPublish

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class MqttPublish

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object o)

Overrides:

equals in class MqttPublish

canEqual

protected boolean canEqual(@Nullable
                           @Nullable java.lang.Object o)

Overrides:

canEqual in class MqttPublish

hashCode

public int hashCode()

Overrides:

hashCode in class MqttPublish