ObjectMap< K, V > Class Template Reference

Implementation of a HashMap for owned objects, i.e. anything created with new(). More...

#include <ObjectMap.h>

Collaboration diagram for ObjectMap< K, V >:

Classes
struct	Entry
	An entry in the ObjectMap. More...
class	Value
	Class to provide safe access to mapped value. More...

Public Member Functions
	ObjectMap ()=default
	~ObjectMap ()
unsigned	count () const
	Get the number of entries in this map. More...
const K &	keyAt (unsigned idx) const
K &	keyAt (unsigned idx)
const V *	valueAt (unsigned idx) const
Value	valueAt (unsigned idx)
const V *	operator[] (const K &key) const
	Get value for given key, if it exists. More...
Value	operator[] (const K &key)
	Access map entry by reference. More...
Value	get (const K &key)
	Get map entry value. More...
void	set (const K &key, V *value)
	Set a key value. More...
V *	find (const K &key) const
	Find the value for a given key, if it exists. More...
int	indexOf (const K &key) const
	Get the index of a key. More...
bool	contains (const K &key) const
	Check if a key is contained within this map. More...
void	removeAt (unsigned index)
	Remove entry at given index. More...
bool	remove (const K &key)
	Remove a key from this map. More...
V *	extract (const K &key)
	Get the value for a given key and remove it from the map, without destroying it. More...
V *	extractAt (unsigned index)
	Get the value at a given index and remove it from the map, without destroying it. More...
void	clear ()
	Clear the map of all entries. More...

Protected Attributes
Vector< Entry >	entries

Detailed Description

template<typename K, typename V>
class ObjectMap< K, V >

Implementation of a HashMap for owned objects, i.e. anything created with new().

Note

Once added to the map the object is destroyed when no longer required.

Example:

void test()
{
   ObjectMap<String, MyType> map;
   MyType* object1 = new MyType();
   if (map["key1"] == nullptr) {   // Does NOT create entry in map
       map["key1"] = object1;      // Entry now created, "key1" -> object1
   }
   MyType* object2 = new MyType();
   map["key1"] = object2;          // object1 is destroyed, "key1" -> object2
 
   // Demonstrate use of value reference
   auto value = map["key1"];       // Returns ObjectMap<String, MyType>::Value object
   value = new MyType();           // "key1" -> new object
   value = nullptr;                // Free object, "key1" -> nullptr (but still in map)
   value.remove();                 // Free object1 and remove from map
 
   // As soon as `map` goes out of scope, all contained objects are destroyed
   map["key1"] = new MyType();
   map["key2"] = new MyType();
}

Constructor & Destructor Documentation

ObjectMap()

template<typename K , typename V >

ObjectMap< K, V >::ObjectMap ( )

default

~ObjectMap()

template<typename K , typename V >

ObjectMap< K, V >::~ObjectMap ( )

inline

Member Function Documentation

clear()

template<typename K , typename V >

void ObjectMap< K, V >::clear ( )

inline

Clear the map of all entries.

contains()

template<typename K , typename V >

bool ObjectMap< K, V >::contains ( const K &  key ) const

inline

Check if a key is contained within this map.

Parameters

key	the key to check

Return values

bool	true if key exists

count()

template<typename K , typename V >

unsigned ObjectMap< K, V >::count ( ) const

inline

Get the number of entries in this map.

Return values

int	Entry count

extract()

template<typename K , typename V >

V* ObjectMap< K, V >::extract ( const K &  key )

inline

Get the value for a given key and remove it from the map, without destroying it.

Parameters

key

Return values

V*

Note

The returned object must be freed by the caller when no longer required

extractAt()

template<typename K , typename V >

V* ObjectMap< K, V >::extractAt ( unsigned  index )

inline

Get the value at a given index and remove it from the map, without destroying it.

Parameters

index

Return values

V*

Note

The returned object must be freed by the caller when no longer required

find()

template<typename K , typename V >

V* ObjectMap< K, V >::find ( const K &  key ) const

inline

Find the value for a given key, if it exists.

Parameters

key

Return values

V*	Points to the object if it exists, otherwise nullptr

Note

If you need to modify the existing map entry, use operator[] or valueAt()

get()

template<typename K , typename V >

Value ObjectMap< K, V >::get ( const K &  key )

inline

Get map entry value.

Parameters

key

Return values

Value

See also

operator[]

indexOf()

template<typename K , typename V >

int ObjectMap< K, V >::indexOf ( const K &  key ) const

inline

Get the index of a key.

Parameters

key

Return values

int	The index of the key, or -1 if key does not exist

keyAt() [1/2]

template<typename K , typename V >

K& ObjectMap< K, V >::keyAt ( unsigned  idx )

inline

keyAt() [2/2]

template<typename K , typename V >

const K& ObjectMap< K, V >::keyAt ( unsigned  idx ) const

inline

operator[]() [1/2]

template<typename K , typename V >

Value ObjectMap< K, V >::operator[] ( const K &  key )

inline

Access map entry by reference.

Parameters

key

Return values

Value

Guarded access to mapped value corresponding to given key

Note

If the given key does not exist in the map it will NOT be created

See also

valueAt()

operator[]() [2/2]

template<typename K , typename V >

const V* ObjectMap< K, V >::operator[] ( const K &  key ) const

inline

Get value for given key, if it exists.

Parameters

key

Return values

const

V* Will be null if not found in the map

Note

The caller must not use delete on the returned value

remove()

template<typename K , typename V >

bool ObjectMap< K, V >::remove ( const K &  key )

inline

Remove a key from this map.

Parameters

key	The key identifying the entry to remove

Return values

bool	true if the value was found and removed

removeAt()

template<typename K , typename V >

void ObjectMap< K, V >::removeAt ( unsigned  index )

inline

Remove entry at given index.

Parameters

index

location to remove from this map

set()

template<typename K , typename V >

void ObjectMap< K, V >::set ( const K &  key, V *  value  )

inline

Set a key value.

Parameters

key
value

valueAt() [1/2]

template<typename K , typename V >

Value ObjectMap< K, V >::valueAt ( unsigned  idx )

inline

valueAt() [2/2]

template<typename K , typename V >

const V* ObjectMap< K, V >::valueAt ( unsigned  idx ) const

inline

Member Data Documentation

entries

template<typename K , typename V >

Vector<Entry> ObjectMap< K, V >::entries

protected

---

The documentation for this class was generated from the following file:

• ObjectMap.h