decaf::util::AbstractMap< K, V, COMPARATOR > Class Template Reference
This class provides a skeletal implementation of the Map interface, to minimize the effort required to implement this interface. More...
#include <src/main/decaf/util/AbstractMap.h>
Public Member Functions | |
| virtual | ~AbstractMap () |
Detailed Description
template<typename K, typename V, typename COMPARATOR>
class decaf::util::AbstractMap< K, V, COMPARATOR >
This class provides a skeletal implementation of the Map interface, to minimize the effort required to implement this interface.
To implement an unmodifiable map, the programmer needs only to extend this class and provide an implementation for the entrySet method, which returns a set-view of the map's mappings. Typically, the returned set will, in turn, be implemented atop AbstractSet. This set should not support the add or remove methods, and its iterator should not support the remove method.
To implement a modifiable map, the programmer must additionally override this class's put method (which otherwise throws an UnsupportedOperationException), and the iterator returned by entrySet().iterator() must additionally implement its remove method.
The programmer should generally provide a void (no argument) and map constructor, as per the recommendation in the Map interface specification.
The documentation for each non-abstract method in this class describes its implementation in detail. Each of these methods may be overridden if the map being implemented admits a more efficient implementation.
- Since:
- 1.0
Constructor & Destructor Documentation
| virtual decaf::util::AbstractMap< K, V, COMPARATOR >::~AbstractMap | ( | ) | [inline, virtual] |
The documentation for this class was generated from the following file:
- src/main/decaf/util/AbstractMap.h
