Package com.hivemq.extension.sdk.api.auth.parameter

Enum TopicPermission.Qos

java.lang.Object

java.lang.Enum<TopicPermission.Qos>

com.hivemq.extension.sdk.api.auth.parameter.TopicPermission.Qos

All Implemented Interfaces:

Serializable, Comparable<TopicPermission.Qos>

Enclosing interface:

TopicPermission

public static enum TopicPermission.Qos
extends Enum<TopicPermission.Qos>

Matching quality of service levels for the topic permission.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Applied for all QoS levels.
ONE	Only applied for QoS 1.
ONE_TWO	Applied for QoS 1 and 2.
TWO	Only applied for QoS 2.
ZERO	Only applied for QoS 0.
ZERO_ONE	Applied for QoS 0 and 1.
ZERO_TWO	Applied for QoS 0 and 2.

Method Summary

Modifier and Type	Method	Description
static TopicPermission.Qos	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TopicPermission.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

ZERO

public static final TopicPermission.Qos ZERO

Only applied for QoS 0.

Since:

4.0.0, CE 2019.1

ONE

public static final TopicPermission.Qos ONE

Only applied for QoS 1.

Since:

4.0.0, CE 2019.1

TWO

public static final TopicPermission.Qos TWO

Only applied for QoS 2.

Since:

4.0.0, CE 2019.1

ZERO_ONE

public static final TopicPermission.Qos ZERO_ONE

Applied for QoS 0 and 1.

Since:

4.0.0, CE 2019.1

ZERO_TWO

public static final TopicPermission.Qos ZERO_TWO

Applied for QoS 0 and 2.

Since:

4.0.0, CE 2019.1

ONE_TWO

public static final TopicPermission.Qos ONE_TWO

Applied for QoS 1 and 2.

Since:

4.0.0, CE 2019.1

ALL

public static final TopicPermission.Qos ALL

Applied for all QoS levels.

Since:

4.0.0, CE 2019.1

Method Detail

values

public static TopicPermission.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 (TopicPermission.Qos c : TopicPermission.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 TopicPermission.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