com.googlecode.ehcache.annotations
Enum DecoratedCacheType

java.lang.Object
  java.lang.Enum<DecoratedCacheType>
      com.googlecode.ehcache.annotations.DecoratedCacheType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DecoratedCacheType>

public enum DecoratedCacheType
extends java.lang.Enum<DecoratedCacheType>

Defines the type of cache decorator that will be added to the cache as it is iteracted with from the cache interceptor

Version:

$Revision: 656 $

Author:

Eric Dalquist

Enum Constant Summary

NONE
No decorator

REFRESHING_SELF_POPULATING_CACHE
Use RefreshingSelfPopulatingCache

SELF_POPULATING_CACHE
Use SelfPopulatingCache

Method Summary

static DecoratedCacheType	getDecoratedCacheType(Cacheable ann, java.lang.reflect.Method method) Determine the DecoratedCacheType for the cacheable annotation
static DecoratedCacheType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DecoratedCacheType[]	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

NONE

public static final DecoratedCacheType NONE

No decorator

SELF_POPULATING_CACHE

public static final DecoratedCacheType SELF_POPULATING_CACHE

Use SelfPopulatingCache

REFRESHING_SELF_POPULATING_CACHE

public static final DecoratedCacheType REFRESHING_SELF_POPULATING_CACHE

Use RefreshingSelfPopulatingCache

Method Detail

values

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

Returns:

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

valueOf

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

getDecoratedCacheType

public static DecoratedCacheType getDecoratedCacheType(Cacheable ann,
                                                       java.lang.reflect.Method method)

Determine the DecoratedCacheType for the cacheable annotation