com.ibm.portal.wcm.plr
Enum CacheSpec.Type

java.lang.Object
  java.lang.Enum<CacheSpec.Type>
      com.ibm.portal.wcm.plr.CacheSpec.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CacheSpec.Type>

Enclosing interface:

CacheSpec

public static enum CacheSpec.Type
extends java.lang.Enum<CacheSpec.Type>

Indicates the type of cache that shall be used to cache the given BeanList object.

Enum Constant Summary

DEFAULT
The default cache.

INVALIDATE_ON_LOGIN
Entries in this cache are automatically invalidated during user login.

Method Summary

static CacheSpec.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CacheSpec.Type[]	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

DEFAULT

public static final CacheSpec.Type DEFAULT

The default cache.

INVALIDATE_ON_LOGIN

public static final CacheSpec.Type INVALIDATE_ON_LOGIN

Entries in this cache are automatically invalidated during user login. The invalidation affects all cache entries that have been put into the cache in context of requests triggered by that user. Implementations of the BeanList using this cache type should return cache keys that are unique for the current user.

Method Detail

values

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

Returns:

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

valueOf

public static CacheSpec.Type valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null