Map template that wraps around a std::map to provide a more user-friendly interface and to provide common functions that do not exist in std::map. More...

#include <src/main/decaf/util/Map.h>

Inheritance diagram for decaf::util::Map< K, V, COMPARATOR >:

[legend]

Data Structures
class	Entry
Public Member Functions
	Map ()
	Default constructor - does nothing.
virtual	~Map ()
virtual bool	equals (const Map &source) const =0
	Comparison, equality is dependent on the method of determining if the element are equal.
virtual void	copy (const Map &source)=0
	Copies the content of the source map into this map.
virtual void	clear ()=0
	Removes all keys and values from this map.
virtual bool	containsKey (const K &key) const =0
	Indicates whether or this map contains a value for the given key.
virtual bool	containsValue (const V &value) const =0
	Indicates whether or this map contains a value for the given value, i.e.
virtual bool	isEmpty () const =0
virtual int	size () const =0
virtual V &	get (const K &key)=0
	Gets the value mapped to the specified key in the Map.
virtual const V &	get (const K &key) const =0
	Gets the value mapped to the specified key in the Map.
virtual void	put (const K &key, const V &value)=0
	Sets the value for the specified key.
virtual void	putAll (const Map< K, V, COMPARATOR > &other)=0
	Stores a copy of the Mappings contained in the other Map in this one.
virtual V	remove (const K &key)=0
	Removes the value (key/value pair) for the specified key from the map, returns a copy of the value that was mapped to the key.
virtual std::vector< K >	keySet () const =0
	Returns a Set view of the mappings contained in this map.
virtual std::vector< V >	values () const =0

Detailed Description

template<typename K, typename V, typename COMPARATOR = std::less<K>>
class decaf::util::Map< K, V, COMPARATOR >

Map template that wraps around a std::map to provide a more user-friendly interface and to provide common functions that do not exist in std::map.

Constructor & Destructor Documentation

template<typename K, typename V, typename COMPARATOR = std::less<K>>

decaf::util::Map< K, V, COMPARATOR >::Map ( ) [inline]

Default constructor - does nothing.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual decaf::util::Map< K, V, COMPARATOR >::~Map ( ) [inline, virtual]

Member Function Documentation

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual void decaf::util::Map< K, V, COMPARATOR >::clear ( ) [pure virtual]

Removes all keys and values from this map.

Exceptions:

UnsupportedOperationException if this map is unmodifiable.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual bool decaf::util::Map< K, V, COMPARATOR >::containsKey ( const K & key ) const [pure virtual]

Indicates whether or this map contains a value for the given key.

Parameters:

key	The key to look up.

Returns:: true if this map contains the value, otherwise false.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual bool decaf::util::Map< K, V, COMPARATOR >::containsValue ( const V & value ) const [pure virtual]

Indicates whether or this map contains a value for the given value, i.e.

they are equal, this is done by operator== so the types must pass equivalence testing in this manner.

Parameters:

value The Value to look up.

Returns:: true if this map contains the value, otherwise false.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual void decaf::util::Map< K, V, COMPARATOR >::copy ( const Map< K, V, COMPARATOR > & source ) [pure virtual]

Copies the content of the source map into this map.

Erases all existing data in this map.

Parameters:

source The source object to copy from.

Implemented in decaf::util::concurrent::ConcurrentStlMap< K, V, COMPARATOR >, and decaf::util::StlMap< K, V, COMPARATOR >.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual bool decaf::util::Map< K, V, COMPARATOR >::equals ( const Map< K, V, COMPARATOR > & source ) const [pure virtual]

Comparison, equality is dependent on the method of determining if the element are equal.

Parameters:

source - Map to compare to this one.

Returns:: true if the Map passed is equal in value to this one.

Implemented in decaf::util::concurrent::ConcurrentStlMap< K, V, COMPARATOR >, and decaf::util::StlMap< K, V, COMPARATOR >.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual V& decaf::util::Map< K, V, COMPARATOR >::get ( const K & key ) [pure virtual]

Gets the value mapped to the specified key in the Map.

If there is no element in the map whose key is equivalent to the key provided then a NoSuchElementException is thrown.

Parameters:

key	The search key.

Returns:: A reference to the value for the given key.

Exceptions:

NoSuchElementException if the key requests doesn't exist in the Map.

Referenced by decaf::util::StlMap< std::string, cms::Topic * >::equals(), decaf::util::concurrent::ConcurrentStlMap< Pointer< ProducerId >, Pointer< ProducerState >, ProducerId::COMPARATOR >::equals(), decaf::util::StlMap< std::string, cms::Topic * >::putAll(), and decaf::util::concurrent::ConcurrentStlMap< Pointer< ProducerId >, Pointer< ProducerState >, ProducerId::COMPARATOR >::putAll().

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual const V& decaf::util::Map< K, V, COMPARATOR >::get ( const K & key ) const [pure virtual]

Gets the value mapped to the specified key in the Map.

If there is no element in the map whose key is equivalent to the key provided then a NoSuchElementException is thrown.

Parameters:

key	The search key.

Returns:: A {const} reference to the value for the given key.

Exceptions:

NoSuchElementException if the key requests doesn't exist in the Map.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual bool decaf::util::Map< K, V, COMPARATOR >::isEmpty ( ) const [pure virtual]

Returns:: if the Map contains any element or not, TRUE or FALSE

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual std::vector<K> decaf::util::Map< K, V, COMPARATOR >::keySet ( ) const [pure virtual]

Returns a Set view of the mappings contained in this map.

The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:: the entire set of keys in this map as a std::vector.

Referenced by decaf::util::StlMap< std::string, cms::Topic * >::equals(), decaf::util::concurrent::ConcurrentStlMap< Pointer< ProducerId >, Pointer< ProducerState >, ProducerId::COMPARATOR >::equals(), decaf::util::StlMap< std::string, cms::Topic * >::putAll(), and decaf::util::concurrent::ConcurrentStlMap< Pointer< ProducerId >, Pointer< ProducerState >, ProducerId::COMPARATOR >::putAll().

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual void decaf::util::Map< K, V, COMPARATOR >::put	(	const K &	key,
		const V &	value
	)		`[pure virtual]`

Sets the value for the specified key.

Parameters:

key	The target key.
value	The value to be set.

Exceptions:

UnsupportedOperationException if this map is unmodifiable.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual void decaf::util::Map< K, V, COMPARATOR >::putAll ( const Map< K, V, COMPARATOR > & other ) [pure virtual]

Stores a copy of the Mappings contained in the other Map in this one.

Parameters:

other A Map instance whose elements are to all be inserted in this Map.

Exceptions:

UnsupportedOperationException If the implementing class does not support the putAll operation.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual V decaf::util::Map< K, V, COMPARATOR >::remove ( const K & key ) [pure virtual]

Removes the value (key/value pair) for the specified key from the map, returns a copy of the value that was mapped to the key.

Parameters:

key	The search key.

Returns:: a copy of the element that was previously mapped to the given key

Exceptions:

NoSuchElementException	if this key is not in the Map.
UnsupportedOperationException	if this map is unmodifiable.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual int decaf::util::Map< K, V, COMPARATOR >::size ( ) const [pure virtual]

Returns:: The number of elements (key/value pairs) in this map.

template<typename K, typename V, typename COMPARATOR = std::less<K>>

virtual std::vector<V> decaf::util::Map< K, V, COMPARATOR >::values ( ) const [pure virtual]

Returns:: the entire set of values in this map as a std::vector.

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

src/main/decaf/util/Map.h

decaf::util::Map< K, V, COMPARATOR > Class Template Reference

Data Structures

Public Member Functions

Detailed Description

template<typename K, typename V, typename COMPARATOR = std::less<K>> class decaf::util::Map< K, V, COMPARATOR >

Constructor & Destructor Documentation

Member Function Documentation

template<typename K, typename V, typename COMPARATOR = std::less<K>>
class decaf::util::Map< K, V, COMPARATOR >