agi.foundation.infrastructure.threading

(agi.foundation.core-2024r3.jar)

Enum PersistentDictionaryAddResult

java.lang.Object

java.lang.Enum<PersistentDictionaryAddResult>

agi.foundation.infrastructure.threading.PersistentDictionaryAddResult

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PersistentDictionaryAddResult>

public enum PersistentDictionaryAddResult
extends Enum<PersistentDictionaryAddResult>
implements Enumeration

Indicates the result of adding a key-value pair to a PersistentDictionary.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXISTING_KEY_NEW_VALUE Indicates that the collection already contained the specified key.
NEW_KEY Indicates that the collection did not previously contain the specified key and it has been added.

Method Summary

Modifier and Type	Method and Description
static PersistentDictionaryAddResult	getDefault() Get the enum constant that is considered to be the default.
static PersistentDictionaryAddResult	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static PersistentDictionaryAddResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static PersistentDictionaryAddResult[]	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

EXISTING_KEY_NEW_VALUE

public static final PersistentDictionaryAddResult EXISTING_KEY_NEW_VALUE

Indicates that the collection already contained the specified key. The value has been replaced in the returned collection.

NEW_KEY

public static final PersistentDictionaryAddResult NEW_KEY

Indicates that the collection did not previously contain the specified key and it has been added.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static PersistentDictionaryAddResult getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static PersistentDictionaryAddResult getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.