Top Description Inners Fields Constructors Methods
net.sf.ehcache.store

public final Class MemoryStoreEvictionPolicy

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, org.slf4j.Logger, .LoggerFactory
A typesafe enumeration of eviction policies. The policy used to evict elements from the net.sf.ehcache.store.MemoryStore. This can be one of:
  1. LRU - least recently used
  2. LFU - least frequently used
  3. FIFO - first in first out, the oldest element by creation time
The default value is LRU
Author
Greg Luck
Since
1.2
Version
$Id: MemoryStoreEvictionPolicy.java 5594 2012-05-07 16:04:31Z cdennis $

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum

Enum for MemoryStoreEvictionPolicy

Field Summary

Modifier and TypeField and Description
public static final MemoryStoreEvictionPolicy
CLOCK

FIFO - first in first out, the oldest element by creation time.

public static final MemoryStoreEvictionPolicy
FIFO

FIFO - first in first out, the oldest element by creation time.

public static final MemoryStoreEvictionPolicy
LFU

LFU - least frequently used.

private static final Logger
LOG

public static final MemoryStoreEvictionPolicy
LRU

LRU - least recently used.

private final String
myName

Constructor Summary

AccessConstructor and Description
private
MemoryStoreEvictionPolicy(String policy)

This class should not be subclassed or have instances created.

Method Summary

Modifier and TypeMethod and Description
public static MemoryStoreEvictionPolicy

Returns:

one of the static instances
fromString(String
either LRU, LFU or FIFO
policy)

Converts a string representation of the policy into a policy.

public String

Returns:

a String representation of the policy
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

CLOCKback to summary
public static final MemoryStoreEvictionPolicy CLOCK

FIFO - first in first out, the oldest element by creation time.

FIFOback to summary
public static final MemoryStoreEvictionPolicy FIFO

FIFO - first in first out, the oldest element by creation time.

LFUback to summary
public static final MemoryStoreEvictionPolicy LFU

LFU - least frequently used.

LOGback to summary
private static final Logger LOG
LRUback to summary
public static final MemoryStoreEvictionPolicy LRU

LRU - least recently used.

myNameback to summary
private final String myName

Constructor Detail

MemoryStoreEvictionPolicyback to summary
private MemoryStoreEvictionPolicy(String policy)

This class should not be subclassed or have instances created.

Method Detail

fromStringback to summary
public static MemoryStoreEvictionPolicy fromString(String policy)

Converts a string representation of the policy into a policy.

Parameters
policy:String

either LRU, LFU or FIFO

Returns:MemoryStoreEvictionPolicy

one of the static instances

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a String representation of the policy

Annotations
@Override
net.sf.ehcache.store back to summary

public final Enum MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum

extends Enum<MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum>
Class Inheritance
Enum for MemoryStoreEvictionPolicy

Field Summary

Modifier and TypeField and Description
public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum
FIFO

Value for MemoryStoreEvictionPolicy#FIFO

public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum
LFU

Value for MemoryStoreEvictionPolicy#LFU

public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum
LRU

Value for MemoryStoreEvictionPolicy#LRU

Constructor Summary

AccessConstructor and Description
private
MemoryStoreEvictionPolicyEnum()

Method Summary

Modifier and TypeMethod and Description
public static MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum
valueOf(String name)

public static MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FIFOback to summary
public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum FIFO

Value for MemoryStoreEvictionPolicy#FIFO

LFUback to summary
public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum LFU

Value for MemoryStoreEvictionPolicy#LFU

LRUback to summary
public static final MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum LRU

Value for MemoryStoreEvictionPolicy#LRU

Constructor Detail

MemoryStoreEvictionPolicyEnumback to summary
private MemoryStoreEvictionPolicyEnum()

Method Detail

valueOfback to summary
public static MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum valueOf(String name)
valuesback to summary
public static MemoryStoreEvictionPolicy.MemoryStoreEvictionPolicyEnum[] values()