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 providedDeliveryTagGenerator
implementations.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EMPTY
Provides aDeliveryTagGenerator
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 aDeliveryTagGenerator
that uses a pool ofDeliveryTag
instances in an attempt to reduce GC overhead on Delivery sends.SEQUENTIAL
Provides aDeliveryTagGenerator
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 aDeliveryTagGenerator
that creates tags based on a UUID value that will be written as two long value encoded into the delivery tag bytes.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
SEQUENTIAL
public static final ProtonDeliveryTagGenerator.BUILTIN SEQUENTIAL
Provides aDeliveryTagGenerator
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 aDeliveryTagGenerator
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 aDeliveryTagGenerator
that uses a pool ofDeliveryTag
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 aDeliveryTagGenerator
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 Detail
-
values
public static ProtonDeliveryTagGenerator.BUILTIN[] 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 (ProtonDeliveryTagGenerator.BUILTIN c : ProtonDeliveryTagGenerator.BUILTIN.values()) System.out.println(c);
- 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 nameNullPointerException
- if the argument is null
-
createGenerator
public abstract DeliveryTagGenerator createGenerator()
- Returns:
- a new
DeliveryTagGenerator
instance as requested from the built in types.
-
-