#include <coherence/util/AbstractMap.hpp>
Inherits Describable, and Map.
Inherited by PofHelper::ReadableEntrySetMap, PofHelper::WriteableEntrySetMap, ContinuousQueryCache, Hashtable, SafeHashMap, and TreeMap.
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 implementations for the entrySet() and iterator() methods. Method entrySet
returns a set-view of the map's mappings. Typically, the returned set will, in turn, be implemented atop AbstractDeepSet
. Method iterator
returns an entry set iterator that points to the mapping for specified key.
To implement a modifiable map, the programmer must additionally override this class's put
, remove
and clear
methods (which otherwise throw an UnsupportedOperationException.
The programmer should generally provide a void (no argument) and map constructor, as per the recommendation in the Map
interface specification.
Public Types | |||||||
typedef spec::Handle | Handle | ||||||
AbstractMap Handle definition. | |||||||
typedef spec::View | View | ||||||
AbstractMap View definition. | |||||||
typedef spec::Holder | Holder | ||||||
AbstractMap Holder definition. | |||||||
Public Member Functions | |||||||
virtual size32_t | size () const | ||||||
Return the number of key-value mappings in this map.
| |||||||
virtual bool | isEmpty () const | ||||||
Return true if this map contains no key-value mappings.
| |||||||
virtual bool | containsKey (Object::View vKey) const | ||||||
Return true if this map contains a mapping for the specified key.
| |||||||
virtual bool | containsValue (Object::View vValue) const | ||||||
Return true if this map maps one or more keys to the specified value.
This operation will probably require time linear in the map size for most implementations of the
| |||||||
virtual Object::Holder | get (Object::View vKey) const | ||||||
Return the value to which this map maps the specified key.
Return
| |||||||
virtual Object::Holder | get (Object::View vKey) | ||||||
Return the value to which this map maps the specified key.
Return
| |||||||
virtual void | putAll (Map::View vMap) | ||||||
Copy all of the mappings from the specified map to this map.
The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key
| |||||||
virtual Set::View | keySet () const | ||||||
Return a set of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined.
| |||||||
virtual Set::Handle | keySet () | ||||||
Return a set of the keys contained in this map. The set is backed by the map, so changes to one are reflected in the other. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined.
| |||||||
virtual Collection::View | values () const | ||||||
Return a collection of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined.
| |||||||
virtual Collection::Handle | values () | ||||||
Return a collection of the values contained in this map. The collection is backed by the map, so changes to one are reflected in the other. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined.
| |||||||
virtual bool | equals (Object::View v) const | ||||||
virtual size32_t | hashCode () const | ||||||
Return a hash code value for the Object. This method is supported for the benefit of hash-based containers.
The general contract of
The default implementation is identity based.
| |||||||
virtual TypedHandle < const String > | toString () const | ||||||
Output a human-readable description of this Object to the given stream. Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents and is generally how toString() will be implemented.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::View vs = COH_TO_STRING(vKey << " = " << vValue); The COH_TO_STRING macro is also the most common way to implement the toString method. For example:
virtual TypedHandle<const String> Person::toString() const { return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN); }
|