com.hivemq.client.mqtt.mqtt5.message.publish.pubrel

Enum Mqtt5PubRelReasonCode

java.lang.Object

java.lang.Enum<Mqtt5PubRelReasonCode>

com.hivemq.client.mqtt.mqtt5.message.publish.pubrel.Mqtt5PubRelReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, Serializable, Comparable<Mqtt5PubRelReasonCode>

public enum Mqtt5PubRelReasonCode
extends Enum<Mqtt5PubRelReasonCode>
implements Mqtt5ReasonCode

Reason Code of an MQTT 5 PubRel message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACKET_IDENTIFIER_NOT_FOUND The packet identifier is not known.
SUCCESS Message released.

Method Summary

Modifier and Type	Method and Description
boolean	canBeSentByClient()
static @Nullable Mqtt5PubRelReasonCode	fromCode(int code) Returns the PubRel Reason Code belonging to the given byte code.
int	getCode()
static Mqtt5PubRelReasonCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Mqtt5PubRelReasonCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.Mqtt5ReasonCode

canBeSentByServer, canBeSetByUser, isError

Enum Constant Detail

SUCCESS

public static final Mqtt5PubRelReasonCode SUCCESS

Message released.

PACKET_IDENTIFIER_NOT_FOUND

public static final Mqtt5PubRelReasonCode PACKET_IDENTIFIER_NOT_FOUND

The packet identifier is not known. This is not an error during recovery, but at other times indicates a mismatch between the session state on the client and server.

Method Detail

values

public static Mqtt5PubRelReasonCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Mqtt5PubRelReasonCode c : Mqtt5PubRelReasonCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Mqtt5PubRelReasonCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Specified by:

getCode in interface Mqtt5ReasonCode

Returns:

the byte code of this Reason Code.

fromCode

@Nullable
public static @Nullable Mqtt5PubRelReasonCode fromCode(int code)

Returns the PubRel Reason Code belonging to the given byte code.

Parameters:

code - the byte code.

Returns:

the PubRel Reason Code belonging to the given byte code or null if the byte code is not a valid PubRel Reason Code.

canBeSentByClient

public boolean canBeSentByClient()

Specified by:

canBeSentByClient in interface Mqtt5ReasonCode

Returns:

whether this Reason Code can be sent by the client according to the MQTT 5 specification.