com.hivemq.spi.message

Enum QoS

java.lang.Object

java.lang.Enum<QoS>

com.hivemq.spi.message.QoS

All Implemented Interfaces:

Serializable, Comparable<QoS>

public enum QoS
extends Enum<QoS>

The Quality of Service level

Since:

1.4

Author:

Dominik Obermaier

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_LEAST_ONCE At least once delivery.
AT_MOST_ONCE At most once delivery.
EXACTLY_ONCE At exactly once delivery.

Method Summary

Methods

Modifier and Type	Method and Description
int	getQosNumber()
static QoS	valueOf(int i) Creates a QoS level enum from an integer
static QoS	valueOf(String name) Returns the enum constant of this type with the specified name.
static QoS[]	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

Enum Constant Detail

AT_MOST_ONCE

public static final QoS AT_MOST_ONCE

At most once delivery. The message will be delivered once or never (best effort delivery)

AT_LEAST_ONCE

public static final QoS AT_LEAST_ONCE

At least once delivery. The message will be delivered once or multiple times

EXACTLY_ONCE

public static final QoS EXACTLY_ONCE

At exactly once delivery. The message will be delivered once and only once

Method Detail

values

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

Returns:

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

valueOf

public static QoS 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

getQosNumber

public int getQosNumber()

Returns:

the integer value of the QoS. Can be 0, 1 or 2

valueOf

@Nullable
public static QoS valueOf(int i)

Creates a QoS level enum from an integer

Parameters:

i - the QoS level as integer (0,1,2)

Returns:

the QoS level or null if an invalid QoS level was passed