org.adroitlogic.ultraesb.api.cache

Enum CacheType

java.lang.Object

java.lang.Enum<CacheType>

org.adroitlogic.ultraesb.api.cache.CacheType

All Implemented Interfaces:

Serializable, Comparable<CacheType>

public enum CacheType
extends Enum<CacheType>

Represents the type of a cache, which may vary depending on the call you made to get hold of it. You could find a complete description of the cache types in the Cache interface

Since:

1.4.0

Author:

sampath

See Also:

Cache

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTRIBUTED_PERMANENT
DISTRIBUTED_PERSISTENT
DISTRIBUTED_TEMP
LOCAL_PERMANENT
LOCAL_PERSISTENT
LOCAL_TEMP

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	isDistributed() Whether this cache type is distributed or in other-words replicated among the cluster
abstract boolean	isPermanent() Whether this cache type is permanent or in other-words guaranteed to exist throughout the session
abstract boolean	isPersistent() Whether this cache type is persistent or in other-words guaranteed to exist within different sessions after JVM restart
static CacheType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CacheType[]	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

LOCAL_PERSISTENT

public static final CacheType LOCAL_PERSISTENT

LOCAL_TEMP

public static final CacheType LOCAL_TEMP

LOCAL_PERMANENT

public static final CacheType LOCAL_PERMANENT

DISTRIBUTED_PERSISTENT

public static final CacheType DISTRIBUTED_PERSISTENT

DISTRIBUTED_TEMP

public static final CacheType DISTRIBUTED_TEMP

DISTRIBUTED_PERMANENT

public static final CacheType DISTRIBUTED_PERMANENT

Method Detail

values

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

Returns:

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

valueOf

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

isDistributed

public abstract boolean isDistributed()

Whether this cache type is distributed or in other-words replicated among the cluster

Returns:

whether the cache is distributed or not

isPermanent

public abstract boolean isPermanent()

Whether this cache type is permanent or in other-words guaranteed to exist throughout the session

Returns:

whether the cache is permanent or not

isPersistent

public abstract boolean isPersistent()

Whether this cache type is persistent or in other-words guaranteed to exist within different sessions after JVM restart

Returns:

whether the cache is persistent or not