Package org.springframework.integration.mqtt.core

Enum Class ConsumerStopAction

java.lang.Object

java.lang.Enum<ConsumerStopAction>

org.springframework.integration.mqtt.core.ConsumerStopAction

All Implemented Interfaces:

Serializable, Comparable<ConsumerStopAction>, Constable

public enum ConsumerStopAction
extends Enum<ConsumerStopAction>

Action to take regarding subscrptions when consumer stops.

Since:

4.2.3

Author:

Gary Russell

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
UNSUBSCRIBE_ALWAYS	Always unsubscribe.
UNSUBSCRIBE_CLEAN	Unsubscribe if clean session is true.
UNSUBSCRIBE_NEVER	Never unsubscribe.

Method Summary

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

UNSUBSCRIBE_NEVER

public static final ConsumerStopAction UNSUBSCRIBE_NEVER

Never unsubscribe.

UNSUBSCRIBE_ALWAYS

public static final ConsumerStopAction UNSUBSCRIBE_ALWAYS

Always unsubscribe.

UNSUBSCRIBE_CLEAN

public static final ConsumerStopAction UNSUBSCRIBE_CLEAN

Unsubscribe if clean session is true.

Method Details

values

public static ConsumerStopAction[] 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 ConsumerStopAction 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