org.apache.ignite.cache.eviction.lru

Class LruEvictionPolicy<K,V>

java.lang.Object

org.apache.ignite.cache.eviction.lru.LruEvictionPolicy<K,V>

All Implemented Interfaces:

Externalizable, Serializable, EvictionPolicy<K,V>, LruEvictionPolicyMBean

public class LruEvictionPolicy<K,V>
extends Object
implements EvictionPolicy<K,V>, LruEvictionPolicyMBean, Externalizable

Eviction policy based on Least Recently Used (LRU) algorithm. This implementation is very efficient since it is lock-free and does not create any additional table-like data structures. The LRU ordering information is maintained by attaching ordering metadata to cache entries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LruEvictionPolicy() Constructs LRU eviction policy with all defaults.
LruEvictionPolicy(int max) Constructs LRU eviction policy with maximum size.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentSize() Gets current queue size.
int	getMaxSize() Gets maximum allowed size of cache before entry will start getting evicted.
void	onEntryAccessed(boolean rmv, EvictableEntry<K,V> entry) Callback for whenever entry is accessed.
Collection<EvictableEntry<K,V>>	queue() Gets read-only view on internal FIFO queue in proper order.
void	readExternal(ObjectInput in)
void	setMaxSize(int max) Sets maximum allowed size of cache before entry will start getting evicted.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LruEvictionPolicy

public LruEvictionPolicy()

Constructs LRU eviction policy with all defaults.

LruEvictionPolicy

public LruEvictionPolicy(int max)

Constructs LRU eviction policy with maximum size.

Parameters:

max - Maximum allowed size of cache before entry will start getting evicted.

Method Detail

getMaxSize

public int getMaxSize()

Gets maximum allowed size of cache before entry will start getting evicted.

Specified by:

getMaxSize in interface LruEvictionPolicyMBean

Returns:

Maximum allowed size of cache before entry will start getting evicted.

setMaxSize

public void setMaxSize(int max)

Sets maximum allowed size of cache before entry will start getting evicted.

Specified by:

setMaxSize in interface LruEvictionPolicyMBean

Parameters:

max - Maximum allowed size of cache before entry will start getting evicted.

getCurrentSize

public int getCurrentSize()

Gets current queue size.

Specified by:

getCurrentSize in interface LruEvictionPolicyMBean

Returns:

Current queue size.

queue

public Collection<EvictableEntry<K,V>> queue()

Gets read-only view on internal FIFO queue in proper order.

Returns:

Read-only view ono internal 'FIFO' queue.

onEntryAccessed

public void onEntryAccessed(boolean rmv,
                   EvictableEntry<K,V> entry)

Callback for whenever entry is accessed.

Specified by:

onEntryAccessed in interface EvictionPolicy<K,V>

Parameters:

rmv - True if entry has been removed, false otherwise.

entry - Accessed entry.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class Object