com.hazelcast.internal.nearcache

Interface NearCacheManager

All Known Implementing Classes:

DefaultNearCacheManager, MapNearCacheManager

public interface NearCacheManager

NearCacheManager is the contract point to manage all existing NearCache instances.

Method Summary

Modifier and Type	Method and Description
void	clearAllNearCaches() Clears all defined NearCache instances.
boolean	clearNearCache(String name) Clears NearCache instance associated with given name but not removes it.
void	destroyAllNearCaches() Destroys all defined NearCache instances.
boolean	destroyNearCache(String name) Destroys NearCache instance associated with given name and also removes it.
<K,V> NearCache<K,V>	getNearCache(String name) Gets the NearCache instance associated with given name.
<K,V> NearCache<K,V>	getOrCreateNearCache(String name, NearCacheConfig nearCacheConfig) Creates a new NearCache with given configurations or returns existing one.
<K,V> NearCache<K,V>	getOrCreateNearCache(String name, NearCacheConfig nearCacheConfig, DataStructureAdapter dataStructureAdapter) Creates a new NearCache with given configurations or returns existing one.
Collection<NearCache>	listAllNearCaches() Lists all existing NearCache instances.

Method Detail

getNearCache

<K,V> NearCache<K,V> getNearCache(String name)

Gets the NearCache instance associated with given name.

Type Parameters:

K - the type of the key for Near Cache

V - the type of the value for Near Cache

Parameters:

name - the name of the NearCache instance will be got

Returns:

the NearCache instance associated with given name

getOrCreateNearCache

<K,V> NearCache<K,V> getOrCreateNearCache(String name,
                                          NearCacheConfig nearCacheConfig)

Creates a new NearCache with given configurations or returns existing one.

Type Parameters:

K - the key type of the NearCache

V - the value type of the NearCache

Parameters:

name - the name of the NearCache to be created or existing one

nearCacheConfig - the NearCacheConfig of the NearCache to be created

Returns:

the created or existing NearCache instance associated with given name

getOrCreateNearCache

<K,V> NearCache<K,V> getOrCreateNearCache(String name,
                                          NearCacheConfig nearCacheConfig,
                                          DataStructureAdapter dataStructureAdapter)

Creates a new NearCache with given configurations or returns existing one. Triggers the pre-loading of the created NearCache via the supplied DataStructureAdapter.

Type Parameters:

K - the key type of the NearCache

V - the value type of the NearCache

Parameters:

name - the name of the NearCache to be created or existing one

nearCacheConfig - the NearCacheConfig of the NearCache to be created

dataStructureAdapter - the DataStructureAdapter of the NearCache to be created

Returns:

the created or existing NearCache instance associated with given name

listAllNearCaches

Collection<NearCache> listAllNearCaches()

Lists all existing NearCache instances.

Returns:

all existing NearCache instances

clearNearCache

boolean clearNearCache(String name)

Clears NearCache instance associated with given name but not removes it.

Parameters:

name - name of the NearCache to be cleared

Returns:

true if NearCache was found and cleared, false otherwise

clearAllNearCaches

void clearAllNearCaches()

Clears all defined NearCache instances.

destroyNearCache

boolean destroyNearCache(String name)

Destroys NearCache instance associated with given name and also removes it.

Parameters:

name - name of the NearCache to be destroyed

Returns:

true if NearCache was found and destroyed, false otherwise

destroyAllNearCaches

void destroyAllNearCaches()

Destroys all defined NearCache instances.