com.hazelcast.cache.hidensity

Interface HiDensityCacheRecordStore<R extends HiDensityCacheRecord>

Type Parameters:

R - Type of the cache record to be stored.

All Superinterfaces:

HiDensityRecordStore<R>, com.hazelcast.cache.impl.ICacheRecordStore

All Known Implementing Classes:

HiDensityNativeMemoryCacheRecordStore, HotRestartHiDensityNativeMemoryCacheRecordStore

public interface HiDensityCacheRecordStore<R extends HiDensityCacheRecord>
extends HiDensityRecordStore<R>, com.hazelcast.cache.impl.ICacheRecordStore

HiDensityCacheRecordStore is the contract for Hi-Density specific cache record store operations. This contract is sub-type of ICacheRecordStore and used by Hi-Density cache based operations.

This HiDensityCacheRecordStore mainly manages operations for HiDensityCacheRecord like get, put, replace, remove, iterate, etc.

See Also:

HiDensityCacheRecordStore, HiDensityNativeMemoryCacheRecordStore

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_PROPERTY_NAME_TO_DISABLE_INVALID_MAX_SIZE_POLICY_EXCEPTION Constant for system property name for enabling/disabling throwing exception behavior in the case of an invalid max-size policy configuration.

Fields inherited from interface com.hazelcast.internal.hidensity.HiDensityRecordStore

DEFAULT_FORCED_EVICTION_PERCENTAGE, FORCE_EVICTION_TRY_COUNT, HUNDRED_PERCENT, NULL_PTR

Method Summary

Modifier and Type	Method and Description
void	disposeDeferredBlocks() Used to release HD memory.
HiDensityRecordProcessor<R>	getRecordProcessor() Gets the HiDensityRecordProcessor which is used by this HiDensityCacheRecordStore.
Object	getRecordValue(R record) Gets the value of specified record.
com.hazelcast.elastic.SlottableIterator<Map.Entry<com.hazelcast.nio.serialization.Data,R>>	iterator(int slot) Returns a slottable iterator for this HiDensityCacheRecordStore to iterate over records.
com.hazelcast.cache.impl.record.CacheRecord	putBackup(com.hazelcast.nio.serialization.Data key, Object value, long creationTime, javax.cache.expiry.ExpiryPolicy expiryPolicy) Puts and saves (replaces if exist) the backup value with the specified key to this HiDensityCacheRecordStore.
boolean	putIfAbsent(com.hazelcast.nio.serialization.Data key, Object value, String caller, int completionId) Puts the value with the specified key to this HiDensityCacheRecordStore if there is no value with the same key.
com.hazelcast.cache.impl.record.CacheRecord	putReplica(com.hazelcast.nio.serialization.Data key, Object value, long creationTime, long ttlMillis) Puts and saves (replaces if exist) the replicated value with the specified key to this HiDensityCacheRecordStore.
boolean	replace(com.hazelcast.nio.serialization.Data key, Object oldValue, Object newValue, String caller, int completionId) Replaces the already stored value with the new value mapped by the specified key to this HiDensityCacheRecordStore if there is a value with the specified key and equals to specified value.
boolean	replace(com.hazelcast.nio.serialization.Data key, Object value, String caller, int completionId) Replaces the already stored value with the new value mapped by the specified key to this HiDensityCacheRecordStore if there is a value with the specified key.
com.hazelcast.nio.serialization.Data	toEventData(Object obj) Converts the given object to data to be sent inside event.
com.hazelcast.cache.impl.record.CacheRecord	toHeapCacheRecord(R record) Converts given HiDensityCacheRecord to heap based CacheRecord.

Methods inherited from interface com.hazelcast.internal.hidensity.HiDensityRecordStore

forceEvict

Methods inherited from interface com.hazelcast.cache.impl.ICacheRecordStore

clear, close, contains, destroy, destroyInternals, evictExpiredEntries, evictIfRequired, fetchEntries, fetchKeys, get, getAll, getAndPut, getAndRemove, getAndReplace, getCacheStats, getConfig, getExpiredKeysQueue, getExpiryPolicy, getName, getObjectNamespace, getPartitionId, getReadOnlyRecords, getRecord, init, invoke, isExpirable, isWanReplicationEnabled, loadAll, merge, merge, put, putIfAbsent, putRecord, remove, remove, remove, removeAll, removeRecord, replace, replace, reset, sampleAndForceRemoveEntries, setExpiryPolicy, size

Field Detail

SYSTEM_PROPERTY_NAME_TO_DISABLE_INVALID_MAX_SIZE_POLICY_EXCEPTION

static final String SYSTEM_PROPERTY_NAME_TO_DISABLE_INVALID_MAX_SIZE_POLICY_EXCEPTION

Constant for system property name for enabling/disabling throwing exception behavior in the case of an invalid max-size policy configuration.

See Also:

Constant Field Values

Method Detail

getRecordValue

Object getRecordValue(R record)

Gets the value of specified record.

Parameters:

record - the record whose value is extracted

Returns:

value of the record

getRecordProcessor

HiDensityRecordProcessor<R> getRecordProcessor()

Gets the HiDensityRecordProcessor which is used by this HiDensityCacheRecordStore.

Returns:

the used Hi-Density cache record processor

putBackup

com.hazelcast.cache.impl.record.CacheRecord putBackup(com.hazelcast.nio.serialization.Data key,
                                                      Object value,
                                                      long creationTime,
                                                      javax.cache.expiry.ExpiryPolicy expiryPolicy)

Puts and saves (replaces if exist) the backup value with the specified key to this HiDensityCacheRecordStore.

Parameters:

key - the key of the value to be owned

value - the value to be owned

expiryPolicy - expiry policy of the owned value

Returns:

the updated (or added) record

putReplica

com.hazelcast.cache.impl.record.CacheRecord putReplica(com.hazelcast.nio.serialization.Data key,
                                                       Object value,
                                                       long creationTime,
                                                       long ttlMillis)

Puts and saves (replaces if exist) the replicated value with the specified key to this HiDensityCacheRecordStore.

Parameters:

key - the key of the value to be owned

value - the value to be owned

ttlMillis - the TTL value in milliseconds for the owned value

Returns:

the updated (or added) record

putIfAbsent

boolean putIfAbsent(com.hazelcast.nio.serialization.Data key,
                    Object value,
                    String caller,
                    int completionId)

Puts the value with the specified key to this HiDensityCacheRecordStore if there is no value with the same key.

Parameters:

key - the key of the value to be put

value - the value to be put

caller - the ID which represents the caller

Returns:

true if the value has been put to the record store, otherwise false

replace

boolean replace(com.hazelcast.nio.serialization.Data key,
                Object value,
                String caller,
                int completionId)

Replaces the already stored value with the new value mapped by the specified key to this HiDensityCacheRecordStore if there is a value with the specified key.

Parameters:

key - the key of the value to be put

value - the value to be put

caller - the ID which represents the caller

Returns:

true if the value has been replaced with the specified value, otherwise false

replace

boolean replace(com.hazelcast.nio.serialization.Data key,
                Object oldValue,
                Object newValue,
                String caller,
                int completionId)

Replaces the already stored value with the new value mapped by the specified key to this HiDensityCacheRecordStore if there is a value with the specified key and equals to specified value.

Parameters:

key - the key of the value to be put

oldValue - the expected value of the record for the specified key

newValue - the new value to be put

caller - the ID which represents the caller

Returns:

true if the value has been replaced with the specified value, otherwise false

iterator

com.hazelcast.elastic.SlottableIterator<Map.Entry<com.hazelcast.nio.serialization.Data,R>> iterator(int slot)

Returns a slottable iterator for this HiDensityCacheRecordStore to iterate over records.

Parameters:

slot - the slot number (or index) to start the iterator

Returns:

the slottable iterator for specified slot

toEventData

com.hazelcast.nio.serialization.Data toEventData(Object obj)

Converts the given object to data to be sent inside event.

Parameters:

obj - the object to be converted to data to be sent inside event

Returns:

the data to be sent

toHeapCacheRecord

com.hazelcast.cache.impl.record.CacheRecord toHeapCacheRecord(R record)

Converts given HiDensityCacheRecord to heap based CacheRecord.

Parameters:

record - the HiDensityCacheRecord to be converted to heap based CacheRecord

Returns:

the heap based CacheRecord converted from the given HiDensityCacheRecord

disposeDeferredBlocks

void disposeDeferredBlocks()

Used to release HD memory.

Specified by:

disposeDeferredBlocks in interface com.hazelcast.cache.impl.ICacheRecordStore