Enum UnsubackReasonCode
- java.lang.Object
-
- java.lang.Enum<UnsubackReasonCode>
-
- com.hivemq.extension.sdk.api.packets.unsuback.UnsubackReasonCode
-
- All Implemented Interfaces:
Serializable
,Comparable<UnsubackReasonCode>
public enum UnsubackReasonCode extends Enum<UnsubackReasonCode>
Reason codes that can be set/contained in anUnsubackPacket
. A reason code describes the outcome for an UNSUBSCRIBE request from a topic.- Since:
- 4.3.0, CE 2020.1
-
-
Enum Constant Summary
Enum Constants Enum Constant Description IMPLEMENTATION_SPECIFIC_ERROR
The UNSUBSCRIBE is valid but the Server does not accept it.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 correctly formed but is not allowed for this Client.UNSPECIFIED_ERROR
The unsubscribe could not be completed and the Server does not wish to reveal the reason or none of the other Reason Codes apply.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static UnsubackReasonCode
valueOf(String name)
Returns the enum constant of this type with the specified name.static UnsubackReasonCode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SUCCESS
public static final UnsubackReasonCode SUCCESS
The subscription is deleted.This is a success code.
- Since:
- 4.3.0, CE 2020.1
-
NO_SUBSCRIPTIONS_EXISTED
public static final UnsubackReasonCode NO_SUBSCRIPTIONS_EXISTED
No matching Topic Filter is being used by the Client.This is a success code.
- Since:
- 4.3.0, CE 2020.1
-
UNSPECIFIED_ERROR
public static final UnsubackReasonCode UNSPECIFIED_ERROR
The unsubscribe could not be completed and the Server does not wish to reveal the reason or none of the other Reason Codes apply.This is an unsuccessful code.
- Since:
- 4.3.0, CE 2020.1
-
IMPLEMENTATION_SPECIFIC_ERROR
public static final UnsubackReasonCode IMPLEMENTATION_SPECIFIC_ERROR
The UNSUBSCRIBE is valid but the Server does not accept it.This is an unsuccessful code.
- Since:
- 4.3.0, CE 2020.1
-
NOT_AUTHORIZED
public static final UnsubackReasonCode NOT_AUTHORIZED
The Client is not authorized to unsubscribe.This is an unsuccessful code.
- Since:
- 4.3.0, CE 2020.1
-
TOPIC_FILTER_INVALID
public static final UnsubackReasonCode TOPIC_FILTER_INVALID
The Topic Filter is correctly formed but is not allowed for this Client.This is an unsuccessful code.
- Since:
- 4.3.0, CE 2020.1
-
PACKET_IDENTIFIER_IN_USE
public static final UnsubackReasonCode PACKET_IDENTIFIER_IN_USE
The specified Packet Identifier is already in use.This is an unsuccessful code.
- Since:
- 4.3.0, CE 2020.1
-
-
Method Detail
-
values
public static UnsubackReasonCode[] 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 (UnsubackReasonCode c : UnsubackReasonCode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static UnsubackReasonCode 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 nameNullPointerException
- if the argument is null
-
-