com.hazelcast.cache.impl.record

Class CacheRecordHashMap

java.lang.Object

java.util.AbstractMap<K,V>

com.hazelcast.util.ConcurrentReferenceHashMap<K,V>

com.hazelcast.util.SampleableConcurrentHashMap<Data,CacheRecord>

com.hazelcast.cache.impl.record.CacheRecordHashMap

All Implemented Interfaces:

CacheRecordMap<Data,CacheRecord>, SampleableCacheRecordMap<Data,CacheRecord>, EvictableStore<Data,CacheRecord>, SampleableEvictableStore<Data,CacheRecord>, IConcurrentMap<Data,CacheRecord>, Serializable, ConcurrentMap<Data,CacheRecord>, Map<Data,CacheRecord>

public class CacheRecordHashMap
extends SampleableConcurrentHashMap<Data,CacheRecord>
implements SampleableCacheRecordMap<Data,CacheRecord>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CacheRecordHashMap.EvictableSamplingEntry

Nested classes/interfaces inherited from class com.hazelcast.util.SampleableConcurrentHashMap

SampleableConcurrentHashMap.SamplingEntry

Nested classes/interfaces inherited from class com.hazelcast.util.ConcurrentReferenceHashMap

ConcurrentReferenceHashMap.Option, ConcurrentReferenceHashMap.ReferenceType, ConcurrentReferenceHashMap.SimpleEntry<K,V>, ConcurrentReferenceHashMap.WriteThroughEntry

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CacheRecordHashMap(int initialCapacity, CacheContext cacheContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map.
protected CacheRecordHashMap.EvictableSamplingEntry	createSamplingEntry(Data key, CacheRecord value)
<C extends EvictionCandidate<Data,CacheRecord>> int	evict(Iterable<C> evictionCandidates, EvictionListener<Data,CacheRecord> evictionListener) The evict method is called by the EvictionStrategy to eventually evict, by the policy, selected candidates from the internal data structures.
CacheKeyIteratorResult	fetchNext(int nextTableIndex, int size) Fetches keys in bulk as specified size at most.
CacheRecord	put(Data key, CacheRecord value) Maps the specified key to the specified value in this table.
CacheRecord	putIfAbsent(Data key, CacheRecord value)
CacheRecord	remove(Object key) Removes the key (and its corresponding value) from this map.
boolean	remove(Object key, Object value)
Iterable<CacheRecordHashMap.EvictableSamplingEntry>	sample(int sampleCount) The sample method is used to sample a number of entries (defined by the samples parameter) from the internal data structure.
void	setEntryCounting(boolean enable) Sets the entry counting behaviour.

Methods inherited from class com.hazelcast.util.SampleableConcurrentHashMap

fetch, getRandomSamples, isValidForFetching, isValidForSampling

Methods inherited from class com.hazelcast.util.ConcurrentReferenceHashMap

applyIfAbsent, contains, containsKey, containsValue, elements, entrySet, get, isEmpty, keys, keySet, purgeStaleEntries, putAll, replace, replace, size, values

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, size, values

Constructor Detail

CacheRecordHashMap

public CacheRecordHashMap(int initialCapacity,
                  CacheContext cacheContext)

Method Detail

setEntryCounting

public void setEntryCounting(boolean enable)

Description copied from interface: CacheRecordMap

Sets the entry counting behaviour. Because, records on backup partitions should not be counted.

Specified by:

setEntryCounting in interface CacheRecordMap<Data,CacheRecord>

Parameters:

enable - enables the entry counting behaviour if it is true, otherwise disables.

put

public CacheRecord put(Data key,
              CacheRecord value)

Description copied from class: ConcurrentReferenceHashMap

Maps the specified key to the specified value in this table. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Specified by:

put in interface Map<Data,CacheRecord>

Overrides:

put in class ConcurrentReferenceHashMap<Data,CacheRecord>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

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

putIfAbsent

public CacheRecord putIfAbsent(Data key,
                      CacheRecord value)

Description copied from class: ConcurrentReferenceHashMap

Specified by:

putIfAbsent in interface ConcurrentMap<Data,CacheRecord>

Overrides:

putIfAbsent in class ConcurrentReferenceHashMap<Data,CacheRecord>

Returns:

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

remove

public CacheRecord remove(Object key)

Description copied from class: ConcurrentReferenceHashMap

Removes the key (and its corresponding value) from this map. This method does nothing if the key is not in the map.

Specified by:

remove in interface Map<Data,CacheRecord>

Overrides:

remove in class ConcurrentReferenceHashMap<Data,CacheRecord>

Parameters:

key - the key that needs to be removed

Returns:

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

remove

public boolean remove(Object key,
             Object value)

Description copied from class: ConcurrentReferenceHashMap

Specified by:

remove in interface ConcurrentMap<Data,CacheRecord>

Overrides:

remove in class ConcurrentReferenceHashMap<Data,CacheRecord>

clear

public void clear()

Description copied from class: ConcurrentReferenceHashMap

Removes all of the mappings from this map.

Specified by:

clear in interface Map<Data,CacheRecord>

Overrides:

clear in class ConcurrentReferenceHashMap<Data,CacheRecord>

createSamplingEntry

protected CacheRecordHashMap.EvictableSamplingEntry createSamplingEntry(Data key,
                                                            CacheRecord value)

Overrides:

createSamplingEntry in class SampleableConcurrentHashMap<Data,CacheRecord>

fetchNext

public CacheKeyIteratorResult fetchNext(int nextTableIndex,
                               int size)

Description copied from interface: CacheRecordMap

Fetches keys in bulk as specified size at most.

Specified by:

fetchNext in interface CacheRecordMap<Data,CacheRecord>

Parameters:

nextTableIndex - starting point for fetching

size - maximum bulk size to fetch the keys

Returns:

the CacheKeyIteratorResult instance contains fetched keys

evict

public <C extends EvictionCandidate<Data,CacheRecord>> int evict(Iterable<C> evictionCandidates,
                                                        EvictionListener<Data,CacheRecord> evictionListener)

Description copied from interface: EvictableStore

The evict method is called by the EvictionStrategy to eventually evict, by the policy, selected candidates from the internal data structures.

Specified by:

evict in interface EvictableStore<Data,CacheRecord>

Parameters:

evictionCandidates - Multiple EvictionCandidate to be evicted

evictionListener - EvictionListener to listen evicted entries

Returns:

evicted entry count

sample

public Iterable<CacheRecordHashMap.EvictableSamplingEntry> sample(int sampleCount)

Description copied from interface: SampleableEvictableStore

The sample method is used to sample a number of entries (defined by the samples parameter) from the internal data structure. This method should be executed in a constant time to deliver predictable timing results of the eviction system.

Specified by:

sample in interface SampleableEvictableStore<Data,CacheRecord>

Parameters:

sampleCount - Entry count to be sampled

Returns:

Multiple EvictionCandidate to be evicted