Package com.hivemq.extension.sdk.api.services.publish

Enum PublishToClientResult

java.lang.Object

java.lang.Enum<PublishToClientResult>

com.hivemq.extension.sdk.api.services.publish.PublishToClientResult

All Implemented Interfaces:

Serializable, Comparable<PublishToClientResult>

public enum PublishToClientResult
extends Enum<PublishToClientResult>

Used to inform if the publish to the client had a matching subscription.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_SUBSCRIBED	The client had no matching subscription.
SUCCESSFUL	The client had a matching subscription.

Method Summary

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

SUCCESSFUL

public static final PublishToClientResult SUCCESSFUL

The client had a matching subscription.

Since:

4.0.0, CE 2019.1

NOT_SUBSCRIBED

public static final PublishToClientResult NOT_SUBSCRIBED

The client had no matching subscription.

Since:

4.0.0, CE 2019.1

Method Detail

values

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

Returns:

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

valueOf

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