Package com.hivemq.client.mqtt.mqtt5.message.subscribe

Enum Class Mqtt5RetainHandling

java.lang.Object

java.lang.Enum<Mqtt5RetainHandling>

com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5RetainHandling

All Implemented Interfaces:

Serializable, Comparable<Mqtt5RetainHandling>, Constable

public enum Mqtt5RetainHandling
extends Enum<Mqtt5RetainHandling>

Retain Handling according to the MQTT 5 specification.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DO_NOT_SEND	Do not send retained messages for the current subscription.
SEND	Send retained messages for the current subscription.
SEND_IF_SUBSCRIPTION_DOES_NOT_EXIST	Send retained messages for the current subscription only if the subscription does not currently exist.

Method Summary

Modifier and Type	Method	Description
static @Nullable Mqtt5RetainHandling	fromCode(int code)	Returns the Retain Handling belonging to the given byte code.
int	getCode()
static Mqtt5RetainHandling	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Mqtt5RetainHandling[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEND

public static final Mqtt5RetainHandling SEND

Send retained messages for the current subscription.

SEND_IF_SUBSCRIPTION_DOES_NOT_EXIST

public static final Mqtt5RetainHandling SEND_IF_SUBSCRIPTION_DOES_NOT_EXIST

Send retained messages for the current subscription only if the subscription does not currently exist.

DO_NOT_SEND

public static final Mqtt5RetainHandling DO_NOT_SEND

Do not send retained messages for the current subscription.

Method Details

values

public static Mqtt5RetainHandling[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Mqtt5RetainHandling valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Returns:

the byte code of this Retain Handling.

fromCode

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

Returns the Retain Handling belonging to the given byte code.

Parameters:

code - the byte code.

Returns:

the Retain Handling belonging to the byte code or null if the byte code is not a valid Retain Handling.