gemfire::HashMapOfCacheable Class Reference

Inherits gemfire::HashMapT< TKEY, TVAL >< gemfire::SharedPtr, gemfire::SharedPtr >, and gemfire::SharedBase.


Detailed Description

A map of CacheableKey objects to Cacheable that also extends SharedBase for smart pointers.

Public Types

typedef
_HashMapOfCacheable::Iterator 
Iterator
 Iterator class for the hash map.

Public Member Functions

Iterator begin () const
 Get an iterator pointing to the start of hash_map.
int32_t bucket_count () const
 Returns the number of buckets used by the hash map.
void clear ()
 Erases all of the elements.
bool contains (const TKEY &k) const
 Check if a given key k exists in the hash map.
int32_t count (const SharedBasePtr &k) const
 Counts the number of elements whose key is k.
bool empty () const
 true if the hash map's size is 0.
Iterator end () const
 Get an iterator pointing to the end of hash_map.
int32_t erase (const TKEY &k)
 Erases the element whose key is k.
Iterator find (const TKEY &k) const
 Finds an element whose key is k.
 HashMapOfCacheable (const HashMapOfCacheable &other)
 Copy constructor.
 HashMapOfCacheable (int32_t n)
 Creates an empty hash map with at least n buckets.
 HashMapOfCacheable ()
 Creates an empty hash map.
bool insert (const TKEY &k, const TVAL &v)
 Inserts the <k, v> pair into the hash map, when k does not exist in the hash map.
int32_t max_size () const
 Returns the largest possible size of the hash map.
TVAL operator[] (const TKEY &k)
 Returns a copy of the object that is associated with a particular key.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
void resize (int32_t n)
 Increases the bucket count to at least n.
int32_t size () const
 Returns the size of the hash map.
void swap (HashMapT &other)
 Swaps the contents of two hash maps.
void update (const TKEY &k, const TVAL &v)
 Updates a value whose key must exist.

Member Typedef Documentation

typedef _HashMapOfCacheable::Iterator gemfire::HashMapOfCacheable::Iterator

Iterator class for the hash map.


Constructor & Destructor Documentation

gemfire::HashMapOfCacheable::HashMapOfCacheable (  )  [inline]

Creates an empty hash map.

gemfire::HashMapOfCacheable::HashMapOfCacheable ( int32_t  n  )  [inline]

Creates an empty hash map with at least n buckets.

gemfire::HashMapOfCacheable::HashMapOfCacheable ( const HashMapOfCacheable other  )  [inline]

Copy constructor.


Member Function Documentation

template<typename TKEY, typename TVAL>
Iterator gemfire::HashMapT< TKEY, TVAL >::begin (  )  const [inline, inherited]

Get an iterator pointing to the start of hash_map.

template<typename TKEY, typename TVAL>
int32_t gemfire::HashMapT< TKEY, TVAL >::bucket_count (  )  const [inline, inherited]

Returns the number of buckets used by the hash map.

template<typename TKEY, typename TVAL>
void gemfire::HashMapT< TKEY, TVAL >::clear (  )  [inline, inherited]

Erases all of the elements.

template<typename TKEY, typename TVAL>
bool gemfire::HashMapT< TKEY, TVAL >::contains ( const TKEY &  k  )  const [inline, inherited]

Check if a given key k exists in the hash map.

template<typename TKEY, typename TVAL>
int32_t gemfire::HashMapT< TKEY, TVAL >::count ( const SharedBasePtr k  )  const [inline, inherited]

Counts the number of elements whose key is k.

template<typename TKEY, typename TVAL>
bool gemfire::HashMapT< TKEY, TVAL >::empty (  )  const [inline, inherited]

true if the hash map's size is 0.

template<typename TKEY, typename TVAL>
Iterator gemfire::HashMapT< TKEY, TVAL >::end (  )  const [inline, inherited]

Get an iterator pointing to the end of hash_map.

template<typename TKEY, typename TVAL>
int32_t gemfire::HashMapT< TKEY, TVAL >::erase ( const TKEY &  k  )  [inline, inherited]

Erases the element whose key is k.

template<typename TKEY, typename TVAL>
Iterator gemfire::HashMapT< TKEY, TVAL >::find ( const TKEY &  k  )  const [inline, inherited]

Finds an element whose key is k.

template<typename TKEY, typename TVAL>
bool gemfire::HashMapT< TKEY, TVAL >::insert ( const TKEY &  k,
const TVAL &  v 
) [inline, inherited]

Inserts the <k, v> pair into the hash map, when k does not exist in the hash map.

template<typename TKEY, typename TVAL>
int32_t gemfire::HashMapT< TKEY, TVAL >::max_size (  )  const [inline, inherited]

Returns the largest possible size of the hash map.

template<typename TKEY, typename TVAL>
TVAL gemfire::HashMapT< TKEY, TVAL >::operator[] ( const TKEY &  k  )  [inline, inherited]

Returns a copy of the object that is associated with a particular key.

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

void gemfire::SharedBase::releaseSB (  )  const [inherited]

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

template<typename TKEY, typename TVAL>
void gemfire::HashMapT< TKEY, TVAL >::resize ( int32_t  n  )  [inline, inherited]

Increases the bucket count to at least n.

template<typename TKEY, typename TVAL>
int32_t gemfire::HashMapT< TKEY, TVAL >::size (  )  const [inline, inherited]

Returns the size of the hash map.

template<typename TKEY, typename TVAL>
void gemfire::HashMapT< TKEY, TVAL >::swap ( HashMapT< TKEY, TVAL > &  other  )  [inline, inherited]

Swaps the contents of two hash maps.

template<typename TKEY, typename TVAL>
void gemfire::HashMapT< TKEY, TVAL >::update ( const TKEY &  k,
const TVAL &  v 
) [inline, inherited]

Updates a value whose key must exist.


GemFire C++ Cache API Documentation