com.atlassian.vcache

Enum PutPolicy

java.lang.Object

java.lang.Enum<PutPolicy>

com.atlassian.vcache.PutPolicy

All Implemented Interfaces:

Serializable, Comparable<PutPolicy>

@PublicApi
public enum PutPolicy
extends Enum<PutPolicy>

Represents the different policies for a put operation on a cache.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_ONLY Only put the value if no value is currently associated with the key.
PUT_ALWAYS Always put the value, regardless of whether a value is currently associated or not.
REPLACE_ONLY Only put the value if a value is currently associated with the key.

Method Summary

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

ADD_ONLY

public static final PutPolicy ADD_ONLY

Only put the value if no value is currently associated with the key.

REPLACE_ONLY

public static final PutPolicy REPLACE_ONLY

Only put the value if a value is currently associated with the key.

PUT_ALWAYS

public static final PutPolicy PUT_ALWAYS

Always put the value, regardless of whether a value is currently associated or not.

Method Detail

values

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

Returns:

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

valueOf

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