Enum Class AcknowledgeMode

java.lang.Object

java.lang.Enum<AcknowledgeMode>

org.springframework.amqp.core.AcknowledgeMode

All Implemented Interfaces:

Serializable, Comparable<AcknowledgeMode>, Constable

public enum AcknowledgeMode
extends Enum<AcknowledgeMode>

Acknowledgment modes supported by the listener container.

Author:

Dave Syer, 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
AUTO	Auto - the container will issue the ack/nack based on whether the listener returns normally, or throws an exception.
MANUAL	Manual acks - user must ack/nack via a channel aware listener.
NONE	No acks - autoAck=true in Channel.basicConsume().

Method Summary

Modifier and Type	Method	Description
boolean	isAutoAck()	Return if the mode is NONE (which is called autoAck in RabbitMQ).
boolean	isManual()	Return true if the mode is MANUAL.
boolean	isTransactionAllowed()	Return if transactions are allowed - if the mode is AUTO or MANUAL.
static AcknowledgeMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AcknowledgeMode[]	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

NONE

public static final AcknowledgeMode NONE

No acks - autoAck=true in Channel.basicConsume().

MANUAL

public static final AcknowledgeMode MANUAL

Manual acks - user must ack/nack via a channel aware listener.

AUTO

public static final AcknowledgeMode AUTO

Auto - the container will issue the ack/nack based on whether the listener returns normally, or throws an exception.

Do not confuse with RabbitMQ autoAck which is represented by NONE here.

Method Details

values

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

isTransactionAllowed

public boolean isTransactionAllowed()

Return if transactions are allowed - if the mode is AUTO or MANUAL.

Returns:

true if transactions are allowed.

isAutoAck

public boolean isAutoAck()

Return if the mode is NONE (which is called autoAck in RabbitMQ).

Returns:

true if the mode is NONE.

isManual

public boolean isManual()

Return true if the mode is MANUAL.

Returns:

true if manual.