com.hazelcast.client.map.impl.nearcache

Class ClientHeapNearCache<K>

java.lang.Object

com.hazelcast.client.map.impl.nearcache.ClientHeapNearCache<K>

Type Parameters:

K -

All Implemented Interfaces:

NearCache<K,Object>

public class ClientHeapNearCache<K>
extends Object
implements NearCache<K,Object>

Implementation of the NearCache.

todo: improve javadoc.

Field Summary

Fields inherited from interface com.hazelcast.cache.impl.nearcache.NearCache

DEFAULT_EXPIRATION_TASK_DELAY_IN_SECONDS, DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_IN_SECONDS, NULL_OBJECT

Constructor Summary

Constructors

Constructor and Description
ClientHeapNearCache(String mapName, ClientContext context, NearCacheConfig nearCacheConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all stored values.
void	destroy() Clears the record store and destroys it.
Object	get(K key) Gets the value associated with the given key.
InMemoryFormat	getInMemoryFormat() Gets the InMemoryFormat of the storage for internal records.
String	getName() Gets the name of the this NearCache instance.
NearCacheStatsImpl	getNearCacheStats() Get the NearCacheStats instance to monitor this store.
boolean	isInvalidateOnChange()
void	put(K key, Object object) Puts (associates) a value with the given key.
boolean	remove(K key) Removes the value associated with the given key.
Object	selectToSave(Object... candidates) Selects the best candidate object to store from the given candidates.
int	size() Gets the count of stored records.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientHeapNearCache

public ClientHeapNearCache(String mapName,
                   ClientContext context,
                   NearCacheConfig nearCacheConfig)

Method Detail

put

public void put(K key,
       Object object)

Description copied from interface: NearCache

Puts (associates) a value with the given key.

Specified by:

put in interface NearCache<K,Object>

Parameters:

key - the key of the value will be stored

object - the value will be stored

getName

public String getName()

Description copied from interface: NearCache

Gets the name of the this NearCache instance.

Specified by:

getName in interface NearCache<K,Object>

Returns:

the name of the this NearCache instance

get

public Object get(K key)

Description copied from interface: NearCache

Gets the value associated with the given key.

Specified by:

get in interface NearCache<K,Object>

Parameters:

key - the key of the requested value

Returns:

the value associated with the given key

remove

public boolean remove(K key)

Description copied from interface: NearCache

Removes the value associated with the given key.

Specified by:

remove in interface NearCache<K,Object>

Parameters:

key - the key of the value will be removed

getNearCacheStats

public NearCacheStatsImpl getNearCacheStats()

Description copied from interface: NearCache

Get the NearCacheStats instance to monitor this store.

Specified by:

getNearCacheStats in interface NearCache<K,Object>

Returns:

the NearCacheStats instance to monitor this store

selectToSave

public Object selectToSave(Object... candidates)

Description copied from interface: NearCache

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

Specified by:

selectToSave in interface NearCache<K,Object>

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.

size

public int size()

Description copied from interface: NearCache

Gets the count of stored records.

Specified by:

size in interface NearCache<K,Object>

Returns:

the count of stored records

clear

public void clear()

Description copied from interface: NearCache

Removes all stored values.

Specified by:

clear in interface NearCache<K,Object>

destroy

public void destroy()

Description copied from interface: NearCache

Clears the record store and destroys it.

Specified by:

destroy in interface NearCache<K,Object>

isInvalidateOnChange

public boolean isInvalidateOnChange()

Specified by:

isInvalidateOnChange in interface NearCache<K,Object>

Returns:

getInMemoryFormat

public InMemoryFormat getInMemoryFormat()

Description copied from interface: NearCache

Gets the InMemoryFormat of the storage for internal records.

Specified by:

getInMemoryFormat in interface NearCache<K,Object>

Returns:

the InMemoryFormat of the storage for internal records