com.googlecode.ehcache.annotations
Enum SelfPopulatingCacheScope

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

All Implemented Interfaces:

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

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

Scope at which the SelfPopulatingCache should be applied.

Version:

$Revision: 656 $

Author:

Eric Dalquist

Enum Constant Summary

METHOD
The SelfPopulatingCache wrapper is only used for invocations on the annotated method.

SHARED
The SelfPopulatingCache wrapper is shared among all methods using the same cache name and marked as self populating.

Method Summary

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

METHOD

public static final SelfPopulatingCacheScope METHOD

The SelfPopulatingCache wrapper is only used for invocations on the annotated method. Other annotations using the same cache name will have their own wrappers.

SHARED

public static final SelfPopulatingCacheScope SHARED

The SelfPopulatingCache wrapper is shared among all methods using the same cache name and marked as self populating.

Method Detail

values

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

Returns:

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

valueOf

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