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

Enum TopicPermission.Retain

java.lang.Object

java.lang.Enum<TopicPermission.Retain>

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

All Implemented Interfaces:

Serializable, Comparable<TopicPermission.Retain>

Enclosing interface:

TopicPermission

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

Represents the type of PUBLISH the topic permission is applied for.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Applied for normal and retained PUBLISH messages.
NOT_RETAINED	Only applied for normal PUBLISH messages.
RETAINED	Only applied for retained PUBLISH messages.

Method Summary

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

RETAINED

public static final TopicPermission.Retain RETAINED

Only applied for retained PUBLISH messages.

Since:

4.0.0, CE 2019.1

NOT_RETAINED

public static final TopicPermission.Retain NOT_RETAINED

Only applied for normal PUBLISH messages.

Since:

4.0.0, CE 2019.1

ALL

public static final TopicPermission.Retain ALL

Applied for normal and retained PUBLISH messages.

Since:

4.0.0, CE 2019.1

Method Detail

values

public static TopicPermission.Retain[] 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.Retain c : TopicPermission.Retain.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.Retain 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