ehcache-core 2.10.9.2 · net.sf.ehcache.store.cachingtier.HeapCacheBackEnd

Modifier and Type	Class and Description
public static interface	HeapCacheBackEnd.EvictionCallback< the key type K, the value type V> An eviction callback

Method Summary

Modifier and Type	Method and Description
public void	clear(final boolean whether to notify listeners or not notify) Basically `CHM.clear()`
public Set<Map.Entry<K, V>>	Returns: the Set of entries entrySet() Deprecated This should go away with the new stats I believe
public V	Returns: the value to which the specified key is mapped, or `null` if this map contains no mapping for the key get(K the key whose associated value is to be returned key) Access a key, basically `CHM.get()`
public Policy	Returns: the policy getPolicy() Deprecated queries the potential eviction policy for the heap caching tier
public boolean	Returns: `true` if there is space for more entries. hasSpace() Return `true` if this tier has enough space for more entries.
public V	Returns: the previous value associated with the specified key, or `null` if there was no mapping for the key. (A `null` return can also indicate that the map previously associated `null` with the key, if the implementation supports null values.) putIfAbsent(K key with which the specified value is to be associated key, V value to be associated with the specified key value) Basically `java.util.concurrent.ConcurrentMap#putIfAbsent(Object, Object)` CHM.putIfAbsent(Object, Object)}, but will evict if required (on successful put)
public void	recalculateSize(K key) Deprecated This is evil!
public void	registerEvictionCallback(HeapCacheBackEnd.EvictionCallback<K, V> the thing to call back on callback) Let's you register a single callback for evictions
public boolean	Returns: `true` if the value was removed remove(K key with which the specified value is associated key, V value expected to be associated with the specified key value) Basically `java.util.concurrent.ConcurrentMap#remove(Object, Object)` CHM.remove(Object, Object)}
public V	Returns: the previous value associated with `key`, or `null` if there was no mapping for `key`. remove(K key whose mapping is to be removed from the map key) Basically `CHM.remove(Object)`
public boolean	Returns: `true` if the value was replaced replace(K key with which the specified value is associated key, V value expected to be associated with the specified key oldValue, V value to be associated with the specified key newValue) Basically `CHM.remove(Object, Object, Object)`
public void	setPolicy(Policy the policy to use policy) Deprecated sets the eviction policy on the heap caching tier
public int	Returns: the amount of mappings installed size() Deprecated This should go away with the new stats I believe

Method Detail

clear back to summary

clear	back to summary
public void clear(final boolean notify) Basically `CHM.clear()` Parameters notify:boolean whether to notify listeners or not

public void clear(final boolean notify)

Basically CHM.clear()

Parameters

notify:boolean: whether to notify listeners or not

entrySet	back to summary
public Set<Map.Entry<K, V>> entrySet() Deprecated This should go away with the new stats I believe Returns:Set<Map.Entry<K, V>> the Set of entries Annotations @Deprecated

entrySet

back to summary

public Set<Map.Entry<K, V>> entrySet()

Deprecated

This should go away with the new stats I believe

Returns:Set<Map.Entry<K, V>>

the Set of entries

Annotations

@Deprecated

get back to summary

get	back to summary
public V get(K key) Access a key, basically `CHM.get()` Parameters key:K the key whose associated value is to be returned Returns:V the value to which the specified key is mapped, or `null` if this map contains no mapping for the key

public V get(K key)

Access a key, basically CHM.get()

Parameters

key:K: the key whose associated value is to be returned

Returns:V

the value to which the specified key is mapped, or null if this map contains no mapping for the key

getPolicy	back to summary
public Policy getPolicy() Deprecated queries the potential eviction policy for the heap caching tier Returns:Policy the policy Annotations @Deprecated

getPolicy

back to summary

public Policy getPolicy()

Deprecated

queries the potential eviction policy for the heap caching tier

Returns:Policy

the policy

Annotations

@Deprecated

hasSpace back to summary

hasSpace	back to summary
public boolean hasSpace() Return `true` if this tier has enough space for more entries. Returns:boolean `true` if there is space for more entries.

public boolean hasSpace()

Return true if this tier has enough space for more entries.

Returns:boolean: true if there is space for more entries.

putIfAbsent back to summary

putIfAbsent	back to summary
public V putIfAbsent(K key, V value) Basically `java.util.concurrent.ConcurrentMap#putIfAbsent(Object, Object)` CHM.putIfAbsent(Object, Object)}, but will evict if required (on successful put) Parameters key:K key with which the specified value is to be associated value:V value to be associated with the specified key Returns:V the previous value associated with the specified key, or `null` if there was no mapping for the key. (A `null` return can also indicate that the map previously associated `null` with the key, if the implementation supports null values.)

public V putIfAbsent(K key, V value)

Basically java.util.concurrent.ConcurrentMap#putIfAbsent(Object, Object) CHM.putIfAbsent(Object, Object)}, but will evict if required (on successful put)

Parameters

key:K: key with which the specified value is to be associated
value:V: value to be associated with the specified key

Returns:V

the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)

recalculateSize	back to summary
public void recalculateSize(K key) Deprecated This is evil! Don't call this! Annotations @Deprecated

recalculateSize

back to summary

public void recalculateSize(K key)

Deprecated

This is evil! Don't call this!

Annotations

@Deprecated

registerEvictionCallback	back to summary
public void registerEvictionCallback(HeapCacheBackEnd.EvictionCallback<K, V> callback) Let's you register a single callback for evictions Parameters callback:HeapCacheBackEnd.EvictionCallback<K, V> the thing to call back on

registerEvictionCallback

back to summary

public void registerEvictionCallback(HeapCacheBackEnd.EvictionCallback<K, V> callback)

Let's you register a single callback for evictions

Parameters

callback:HeapCacheBackEnd.EvictionCallback<K, V>: the thing to call back on

remove back to summary

remove	back to summary
public boolean remove(K key, V value) Basically `java.util.concurrent.ConcurrentMap#remove(Object, Object)` CHM.remove(Object, Object)} Parameters key:K key with which the specified value is associated value:V value expected to be associated with the specified key Returns:boolean `true` if the value was removed

public boolean remove(K key, V value)

Basically java.util.concurrent.ConcurrentMap#remove(Object, Object) CHM.remove(Object, Object)}

Parameters

key:K: key with which the specified value is associated
value:V: value expected to be associated with the specified key

Returns:boolean

true if the value was removed

remove back to summary

remove	back to summary
public V remove(K key) Basically `CHM.remove(Object)` Parameters key:K key whose mapping is to be removed from the map Returns:V the previous value associated with `key`, or `null` if there was no mapping for `key`.

public V remove(K key)

Basically CHM.remove(Object)

Parameters

key:K: key whose mapping is to be removed from the map

Returns:V

the previous value associated with key, or null if there was no mapping for key.

replace back to summary

replace	back to summary
public boolean replace(K key, V oldValue, V newValue) Basically `CHM.remove(Object, Object, Object)` Parameters key:K key with which the specified value is associated oldValue:V value expected to be associated with the specified key newValue:V value to be associated with the specified key Returns:boolean `true` if the value was replaced

public boolean replace(K key, V oldValue, V newValue)

Basically CHM.remove(Object, Object, Object)

Parameters

key:K: key with which the specified value is associated
oldValue:V: value expected to be associated with the specified key
newValue:V: value to be associated with the specified key

Returns:boolean

true if the value was replaced

setPolicy	back to summary
public void setPolicy(Policy policy) Deprecated sets the eviction policy on the heap caching tier Parameters policy:Policy the policy to use Annotations @Deprecated

setPolicy

back to summary

public void setPolicy(Policy policy)

Deprecated

sets the eviction policy on the heap caching tier

Parameters

policy:Policy: the policy to use

Annotations

@Deprecated

size	back to summary
public int size() Deprecated This should go away with the new stats I believe Returns:int the amount of mappings installed Annotations @Deprecated

size

back to summary

public int size()

Deprecated

This should go away with the new stats I believe

Returns:int

the amount of mappings installed

Annotations

@Deprecated

public Interface HeapCacheBackEnd<K, V>

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface HeapCacheBackEnd.EvictionCallback<K, V>

Method Summary

Method Detail