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

Enum Mqtt5PubAckReasonCode

java.lang.Object

java.lang.Enum<Mqtt5PubAckReasonCode>

com.hivemq.client.mqtt.mqtt5.message.publish.puback.Mqtt5PubAckReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, java.io.Serializable, java.lang.Comparable<Mqtt5PubAckReasonCode>

public enum Mqtt5PubAckReasonCode
extends java.lang.Enum<Mqtt5PubAckReasonCode>
implements Mqtt5ReasonCode

Reason Code of a MQTT 5 PubAck message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMPLEMENTATION_SPECIFIC_ERROR
NO_MATCHING_SUBSCRIBERS
NOT_AUTHORIZED
PACKET_IDENTIFIER_IN_USE
PAYLOAD_FORMAT_INVALID
QUOTA_EXCEEDED
SUCCESS
TOPIC_NAME_INVALID
UNSPECIFIED_ERROR

Method Summary

Modifier and Type	Method and Description
boolean	canBeSentByClient()
boolean	canBeSetByUser()
static @Nullable Mqtt5PubAckReasonCode	fromCode(int code) Returns the PubAck Reason Code belonging to the given byte code.
int	getCode()
static Mqtt5PubAckReasonCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Mqtt5PubAckReasonCode[]	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, isError

Enum Constant Detail

SUCCESS

public static final Mqtt5PubAckReasonCode SUCCESS

NO_MATCHING_SUBSCRIBERS

public static final Mqtt5PubAckReasonCode NO_MATCHING_SUBSCRIBERS

UNSPECIFIED_ERROR

public static final Mqtt5PubAckReasonCode UNSPECIFIED_ERROR

IMPLEMENTATION_SPECIFIC_ERROR

public static final Mqtt5PubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR

NOT_AUTHORIZED

public static final Mqtt5PubAckReasonCode NOT_AUTHORIZED

TOPIC_NAME_INVALID

public static final Mqtt5PubAckReasonCode TOPIC_NAME_INVALID

PACKET_IDENTIFIER_IN_USE

public static final Mqtt5PubAckReasonCode PACKET_IDENTIFIER_IN_USE

QUOTA_EXCEEDED

public static final Mqtt5PubAckReasonCode QUOTA_EXCEEDED

PAYLOAD_FORMAT_INVALID

public static final Mqtt5PubAckReasonCode PAYLOAD_FORMAT_INVALID

Method Detail

values

public static Mqtt5PubAckReasonCode[] 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 (Mqtt5PubAckReasonCode c : Mqtt5PubAckReasonCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Mqtt5PubAckReasonCode valueOf(java.lang.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:

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

java.lang.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 Mqtt5PubAckReasonCode fromCode(int code)

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

Parameters:

code - the byte code.

Returns:

the PubAck Reason Code belonging to the given byte code or null if the byte code is not a valid PubAck 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.

canBeSetByUser

public boolean canBeSetByUser()

Specified by:

canBeSetByUser in interface Mqtt5ReasonCode

Returns:

whether this Reason Code can be set by the user.