Package org.infinispan.reactive.publisher.impl

Enum DeliveryGuarantee

java.lang.Object

java.lang.Enum<DeliveryGuarantee>

org.infinispan.reactive.publisher.impl.DeliveryGuarantee

All Implemented Interfaces:

Serializable, Comparable<DeliveryGuarantee>

public enum DeliveryGuarantee
extends Enum<DeliveryGuarantee>

Enumeration defining the possible delivery guarantees for entries.

Since:

10.0

Author:

wburns

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_LEAST_ONCE	The in between guarantee that provides a view of all data, but may return duplicates during a toplogy change.
AT_MOST_ONCE	The least strict guarantee that ensures that data is never read more than once, but may be missed.
EXACTLY_ONCE	The most strict guarantee that guarantees that an entry is seen exactly one time in results.

Method Summary

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

AT_MOST_ONCE

public static final DeliveryGuarantee AT_MOST_ONCE

The least strict guarantee that ensures that data is never read more than once, but may be missed. This guarantee is most performant as it never requires retrying data or returning extra data for the sake of consistency. However, under a stable topology this will return the same results as EXACTLY_ONCE.

AT_LEAST_ONCE

public static final DeliveryGuarantee AT_LEAST_ONCE

The in between guarantee that provides a view of all data, but may return duplicates during a toplogy change. This guarantee does not send identity values, but instead will retry an operation, most likely returning duplicates. However, under a stable topology this will return the same results as EXACTLY_ONCE.

EXACTLY_ONCE

public static final DeliveryGuarantee EXACTLY_ONCE

The most strict guarantee that guarantees that an entry is seen exactly one time in results. This is the most expensive guarantee as it may require copying identity values to the originator (ie. keys) to ensure that a value is not returned more than once for a given key.

Method Detail

values

public static DeliveryGuarantee[] 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 (DeliveryGuarantee c : DeliveryGuarantee.values())
    System.out.println(c);

Returns:

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

valueOf

public static DeliveryGuarantee 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

valueOf

public static DeliveryGuarantee valueOf(int index)

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:

index - 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