Package org.apache.qpid.protonj2.engine.impl

Enum ProtonDeliveryTagGenerator.BUILTIN

java.lang.Object

java.lang.Enum<ProtonDeliveryTagGenerator.BUILTIN>

org.apache.qpid.protonj2.engine.impl.ProtonDeliveryTagGenerator.BUILTIN

All Implemented Interfaces:

Serializable, Comparable<ProtonDeliveryTagGenerator.BUILTIN>

Enclosing class:

ProtonDeliveryTagGenerator

public static enum ProtonDeliveryTagGenerator.BUILTIN
extends Enum<ProtonDeliveryTagGenerator.BUILTIN>

An enumeration of the Proton provided DeliveryTagGenerator implementations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY	Provides a DeliveryTagGenerator that returns a singleton empty tag value that can be used by senders that are sending settled deliveries and simply need to provide a non-null tag value to the outgoing delivery instance.
POOLED	Provides a DeliveryTagGenerator that uses a pool of DeliveryTag instances in an attempt to reduce GC overhead on Delivery sends.
SEQUENTIAL	Provides a DeliveryTagGenerator that creates tags based on an incrementing numeric value starting from zero and moving upwards until the value wraps and continue back towards zero.
UUID	Provides a DeliveryTagGenerator that creates tags based on a UUID value that will be written as two long value encoded into the delivery tag bytes.

Method Summary

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

SEQUENTIAL

public static final ProtonDeliveryTagGenerator.BUILTIN SEQUENTIAL

Provides a DeliveryTagGenerator that creates tags based on an incrementing numeric value starting from zero and moving upwards until the value wraps and continue back towards zero.

UUID

public static final ProtonDeliveryTagGenerator.BUILTIN UUID

Provides a DeliveryTagGenerator that creates tags based on a UUID value that will be written as two long value encoded into the delivery tag bytes.

POOLED

public static final ProtonDeliveryTagGenerator.BUILTIN POOLED

Provides a DeliveryTagGenerator that uses a pool of DeliveryTag instances in an attempt to reduce GC overhead on Delivery sends. The tags are created using a numeric base value that is incremented as new tag values are requested and none can be produced from the tag pool.

EMPTY

public static final ProtonDeliveryTagGenerator.BUILTIN EMPTY

Provides a DeliveryTagGenerator that returns a singleton empty tag value that can be used by senders that are sending settled deliveries and simply need to provide a non-null tag value to the outgoing delivery instance.

Method Details

values

public static ProtonDeliveryTagGenerator.BUILTIN[] values()

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

Returns:

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

valueOf

public static ProtonDeliveryTagGenerator.BUILTIN 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

createGenerator

public abstract DeliveryTagGenerator createGenerator()

Returns:

a new DeliveryTagGenerator instance as requested from the built in types.