com.goldencode.cache

Enum CapacityPolicy

java.lang.Object

java.lang.Enum<CapacityPolicy>

com.goldencode.cache.CapacityPolicy

All Implemented Interfaces:

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

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

This enumeration describes the policy applied in the situation where an attempt to expire one or more elements of an expiry cache fails, due to an expiration test function overriding enough expiration candidates such that a new element could not be added without growing the cache beyond its set size limit.

The policy may be lenient or strict. A lenient policy allows the cache to grow beyond its set limit. The limit will be increased, and a warning will be logged when this occurs. A strict policy will not allow the cache to grow beyond its limit, and an exception will be thrown in the event capacity for a new element cannot be ensured.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LENIENT Allow the cache to grow.
STRICT Do not allow the cache to grow.

Method Summary

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

LENIENT

public static final CapacityPolicy LENIENT

Allow the cache to grow.

STRICT

public static final CapacityPolicy STRICT

Do not allow the cache to grow.

Method Detail

values

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

Returns:

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

valueOf

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