com.att.nsa.apiClient.http

Enum CacheUse

java.lang.Object

java.lang.Enum<CacheUse>

com.att.nsa.apiClient.http.CacheUse

All Implemented Interfaces:

Serializable, Comparable<CacheUse>

public enum CacheUse
extends Enum<CacheUse>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The operation may use the cache specified for default setup when it does not have a specific cache use for this operation
FULL The operation may read from and write to the local object cache.
NONE The operation may neither read from nor write to the local object cache.
WRITE_ONLY The operation may write to the local object cache but not read from it.

Method Summary

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

FULL

public static final CacheUse FULL

The operation may read from and write to the local object cache. Use this for typical operations.

NONE

public static final CacheUse NONE

The operation may neither read from nor write to the local object cache. Use this for transient values.

WRITE_ONLY

public static final CacheUse WRITE_ONLY

The operation may write to the local object cache but not read from it. This is helpful when the system knows it needs a refreshed value now (e.g. an event signaled an update), but can re-use it from the cache until another signal is received.

DEFAULT

public static final CacheUse DEFAULT

The operation may use the cache specified for default setup when it does not have a specific cache use for this operation

Method Detail

values

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

Returns:

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

valueOf

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