Oracle Coherence for C++ API: ConverterCollections::ConverterCacheMap Class Reference

Detailed Description

A ConverterCacheMap views an underlying CacheMap through a set of key and value Converters.

Public Types

typedef spec::Handle

Handle

ConverterCacheMap Handle definition.

typedef spec::View

View

ConverterCacheMap View definition.

typedef spec::Holder

Holder

ConverterCacheMap Holder definition.

Public Member Functions

virtual Map::View

getAll (Collection::View vKeys) const

virtual Object::Holder

put (Object::View vKey, Object::Holder ohValue, int64_t cMillis)

Associates the specified value with the specified key in this cache.

If the cache previously contained a mapping for this key, the old value is replaced. This variation of the put(Object::View, Object::View) method allows the caller to specify an expiry (or "time to live") for the cache entry.

Parameters:

	vKey	key with which the specified value is to be associated
	ohValue	value to be associated with the specified key
	cMillis	the number of milliseconds until the cache entry will expire, also referred to as the entry's "time to live"; pass expiry_default to use the cache's default time-to-live setting; pass expiry_never to indicate that the cache entry should never expire; this milliseconds value is not a date/time value

Returns:: previous value associated with specified key, or empty handle if there was no mapping for key. An empty handle return can also indicate that the map previously associated NULL with the specified key, if the implementation supports NULL values

Exceptions:

coherence::lang::UnsupportedOperationException

if the requested expiry is a positive value and the implementation does not support expiry of cache entries

virtual CacheMap::View

getCacheMap () const

Return the underlying CacheMap.

virtual CacheMap::Handle

getCacheMap ()

Return the underlying CacheMap.

Protected Member Functions

ConverterCacheMap (CacheMap::Handle hMapDelegate, EntryConverter::View vConvUp, EntryConverter::View vConvDown)

Create a ConverterCacheMap which delegates to the specified CacheMap.

ConverterCacheMap (CacheMap::View vMapDelegate, EntryConverter::View vConvUp, EntryConverter::View vConvDown)

Create a ConverterCacheMap which delegates to the specified CacheMap.

Constructor & Destructor Documentation

ConverterCacheMap	(	CacheMap::Handle	hMapDelegate,
		EntryConverter::View	vConvUp,
		EntryConverter::View	vConvDown
	)			`[protected]`

Create a ConverterCacheMap which delegates to the specified CacheMap.

Parameters:

	hMap	the specified CacheMap
	vConvUp	the EntryConverter from the underlying Map
	vConvDown	the EntryConverter to the underlying Map

ConverterCacheMap	(	CacheMap::View	vMapDelegate,
		EntryConverter::View	vConvUp,
		EntryConverter::View	vConvDown
	)			`[protected]`

Create a ConverterCacheMap which delegates to the specified CacheMap.

Parameters:

	vMap	the specified CacheMap
	vConvUp	the EntryConverter from the underlying Map
	vConvDown	the EntryConverter to the underlying Map

Member Function Documentation

virtual CacheMap::View getCacheMap ( ) const [virtual]

Return the underlying CacheMap.

Returns:: the underlying CacheMap

virtual CacheMap::Handle getCacheMap ( ) [virtual]

Return the underlying CacheMap.

Returns:: the underlying CacheMap