com.hazelcast.internal.nearcache

Interface NearCacheRecordStore<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

All Superinterfaces:

InitializingObject

All Known Implementing Classes:

AbstractNearCacheRecordStore, BaseHeapNearCacheRecordStore, NearCacheDataRecordStore, NearCacheObjectRecordStore

public interface NearCacheRecordStore<K,V>
extends InitializingObject

NearCacheRecordStore is the contract point to store keys and values as NearCacheRecord internally and to serve them.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stored values.
void	destroy() Clears the record store and destroys it.
void	doEviction() Does eviction as specified configuration EvictionConfig in NearCacheConfig regardless from the max-size policy.
void	doEvictionIfRequired() Does eviction as specified configuration EvictionConfig in NearCacheConfig.
void	doExpiration() Performs expiration and evicts expired records.
V	get(K key) Gets the value associated with the given key.
NearCacheStats	getNearCacheStats() Get the NearCacheStats instance to monitor this record store.
NearCacheRecord	getRecord(K key) Gets the record associated with the given key.
StaleReadDetector	getStaleReadDetector()
void	invalidate(K key) Removes the value associated with the given key and increases the invalidation statistics.
boolean	isAvailable()
void	loadKeys(DataStructureAdapter<Object,?> adapter) Loads the keys into the Near Cache.
void	put(K key, Data keyData, V value) Puts (associates) a value with the given key.
Object	selectToSave(Object... candidates) Selects the best candidate object to store from the given candidates.
void	setStaleReadDetector(StaleReadDetector detector)
int	size() Gets the number of stored records.
void	storeKeys() Persists the key set of the Near Cache.
V	tryPublishReserved(K key, V value, long reservationId, boolean deserialize)
long	tryReserveForUpdate(K key, Data keyData)

Methods inherited from interface com.hazelcast.spi.InitializingObject

initialize

Method Detail

get

V get(K key)

Gets the value associated with the given key.

Parameters:

key - the key from which to get the associated value.

Returns:

the value associated with the given key.

put

void put(K key,
         Data keyData,
         V value)

Puts (associates) a value with the given key.

Parameters:

key - the key to which the given value will be associated.

keyData - the key as Data to which the given value will be associated.

value - the value that will be associated with the key.

invalidate

void invalidate(K key)

Removes the value associated with the given key and increases the invalidation statistics.

Parameters:

key - the key of the value will be invalidated

clear

void clear()

Removes all stored values.

destroy

void destroy()

Clears the record store and destroys it.

size

int size()

Gets the number of stored records.

Returns:

the number of stored records.

getRecord

NearCacheRecord getRecord(K key)

Gets the record associated with the given key.

Parameters:

key - the key from which to get the associated NearCacheRecord.

Returns:

the NearCacheRecord associated with the given key.

getNearCacheStats

NearCacheStats getNearCacheStats()

Get the NearCacheStats instance to monitor this record store.

Returns:

the NearCacheStats instance to monitor this record store.

selectToSave

Object selectToSave(Object... candidates)

Selects the best candidate object to store from the given candidates.

Parameters:

candidates - the candidates from which the best candidate object will be selected.

Returns:

the best candidate object to store, selected from the given candidates.

doExpiration

void doExpiration()

Performs expiration and evicts expired records.

doEvictionIfRequired

void doEvictionIfRequired()

Does eviction as specified configuration EvictionConfig in NearCacheConfig.

doEviction

void doEviction()

Does eviction as specified configuration EvictionConfig in NearCacheConfig regardless from the max-size policy.

loadKeys

void loadKeys(DataStructureAdapter<Object,?> adapter)

Loads the keys into the Near Cache.

storeKeys

void storeKeys()

Persists the key set of the Near Cache.

setStaleReadDetector

void setStaleReadDetector(StaleReadDetector detector)

See Also:

StaleReadDetector

getStaleReadDetector

StaleReadDetector getStaleReadDetector()

See Also:

StaleReadDetector

tryReserveForUpdate

long tryReserveForUpdate(K key,
                         Data keyData)

tryPublishReserved

V tryPublishReserved(K key,
                     V value,
                     long reservationId,
                     boolean deserialize)

isAvailable

boolean isAvailable()