com.hivemq.client.mqtt.mqtt5.message.unsubscribe.unsuback

Enum Mqtt5UnsubAckReasonCode

java.lang.Object

java.lang.Enum<Mqtt5UnsubAckReasonCode>

com.hivemq.client.mqtt.mqtt5.message.unsubscribe.unsuback.Mqtt5UnsubAckReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, Serializable, Comparable<Mqtt5UnsubAckReasonCode>

public enum Mqtt5UnsubAckReasonCode
extends Enum<Mqtt5UnsubAckReasonCode>
implements Mqtt5ReasonCode

Reason Code of an MQTT 5 UnsubAck message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMPLEMENTATION_SPECIFIC_ERROR The UNSUBSCRIBE packet is valid but is not accepted by the server.
NO_SUBSCRIPTIONS_EXISTED No matching topic filter is being used by the client.
NOT_AUTHORIZED The client is not authorized to unsubscribe.
PACKET_IDENTIFIER_IN_USE The specified packet identifier is already in use.
SUCCESS The subscription is deleted.
TOPIC_FILTER_INVALID The topic filter is formed correctly but is not accepted by the server (for this client).
UNSPECIFIED_ERROR The server either does not want to reveal the reason for the failure or none of the other reason codes apply.

Method Summary

Modifier and Type	Method and Description
static @Nullable Mqtt5UnsubAckReasonCode	fromCode(int code) Returns the UnsubAck Reason Code belonging to the given byte code.
int	getCode()
static Mqtt5UnsubAckReasonCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Mqtt5UnsubAckReasonCode[]	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

canBeSentByClient, canBeSentByServer, canBeSetByUser, isError

Enum Constant Detail

SUCCESS

public static final Mqtt5UnsubAckReasonCode SUCCESS

The subscription is deleted.

NO_SUBSCRIPTIONS_EXISTED

public static final Mqtt5UnsubAckReasonCode NO_SUBSCRIPTIONS_EXISTED

No matching topic filter is being used by the client.

UNSPECIFIED_ERROR

public static final Mqtt5UnsubAckReasonCode UNSPECIFIED_ERROR

The server either does not want to reveal the reason for the failure or none of the other reason codes apply.

IMPLEMENTATION_SPECIFIC_ERROR

public static final Mqtt5UnsubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR

The UNSUBSCRIBE packet is valid but is not accepted by the server.

NOT_AUTHORIZED

public static final Mqtt5UnsubAckReasonCode NOT_AUTHORIZED

The client is not authorized to unsubscribe.

TOPIC_FILTER_INVALID

public static final Mqtt5UnsubAckReasonCode TOPIC_FILTER_INVALID

The topic filter is formed correctly but is not accepted by the server (for this client).

PACKET_IDENTIFIER_IN_USE

public static final Mqtt5UnsubAckReasonCode PACKET_IDENTIFIER_IN_USE

The specified packet identifier is already in use.

Method Detail

values

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

Returns:

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

valueOf

public static Mqtt5UnsubAckReasonCode 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 Mqtt5UnsubAckReasonCode fromCode(int code)

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

Parameters:

code - the byte code.

Returns:

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