Enum Class ConsumerStopAction

java.lang.Object
java.lang.Enum<ConsumerStopAction>
org.springframework.integration.mqtt.core.ConsumerStopAction
All Implemented Interfaces:
Serializable, Comparable<ConsumerStopAction>, Constable

@Deprecated public enum ConsumerStopAction extends Enum<ConsumerStopAction>
Deprecated.
since 5.5.17 in favor of standard MqttConnectOptions.setCleanSession(boolean). Will be removed in 6.1.0.
Action to take regarding subscriptions when consumer stops.
Since:
4.2.3
Author:
Gary Russell
  • Enum Constant Details

    • UNSUBSCRIBE_NEVER

      public static final ConsumerStopAction UNSUBSCRIBE_NEVER
      Deprecated.
      Never unsubscribe.
    • UNSUBSCRIBE_ALWAYS

      public static final ConsumerStopAction UNSUBSCRIBE_ALWAYS
      Deprecated.
      Always unsubscribe.
    • UNSUBSCRIBE_CLEAN

      public static final ConsumerStopAction UNSUBSCRIBE_CLEAN
      Deprecated.
      Unsubscribe if clean session is true.
  • Method Details

    • values

      public static ConsumerStopAction[] values()
      Deprecated.
      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)
      Deprecated.
      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