Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

TypedCollections::TypedMap Class Template Reference

#include <coherence/util/TypedCollections.hpp>

Inherits WrapperCollections::AbstractWrapperMap.

List of all members.


Detailed Description

template<class K, class V>
class coherence::util::TypedCollections::TypedMap< K, V >

Typed wrapper over Map interface.

Public Types

typedef spec::Handle  Handle
  TypedMap<K, V> Handle definition.
typedef spec::View  View
  TypedMap<K, V> View definition.
typedef spec::Holder  Holder
  TypedMap<K, V> Holder definition.
typedef K  KeyType
  The type of the map's keys, e.g.
typedef V  ValueType
  The type of the map's values, e.g.
typedef TypedEntry
< KeyType, ValueType
Entry
  The type of the entries stored in this map.
typedef TypedSet
< KeyType
KeySet
  The type of the key set associated with this map.
typedef
TypedCollection
< ValueType
ValueCollection
  The type of the values collection associated with this map.
typedef TypedSet
< typename
Entry::View
EntrySet
  The type of the entry set associated with this map.

Public Member Functions

virtual bool  containsKey (KeyType vKey) const
  The typed version of the method Map::containsKey.
virtual bool  containsValue (ValueType ohValue) const
  The typed version of the method Map::containsValue.
virtual ValueType  get (KeyType vKey) const
  The typed version of the method Map::get.
virtual ValueType  get (KeyType vKey)
  The typed version of the method Map::get.
virtual ValueType  put (KeyType vKey, ValueType ohValue)
  The typed version of the method Map::put.
virtual ValueType  remove (KeyType vKey)
  The typed version of the method Map::put.
virtual void  putAll (typename TypedMap::View vMap)
  The typed version of the method Map::putAll.
virtual KeySet::View  keySetTyped () const
  The typed version of the method Map::keySet.
virtual KeySet::Handle  keySetTyped ()
  The typed version of the method Map::keySet.
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.

Returns:
a set of the keys contained in this map.

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.

Returns:
a set of the keys contained in this map.

virtual
ValueCollection::View 
valuesTyped () const
  The typed version of the method Map::values.
virtual
ValueCollection::Handle 
valuesTyped ()
  The typed version of the method Map::values.
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.

Returns:
a collection of the values contained in this map.

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.

Returns:
a collection of the values contained in this map.

virtual EntrySet::View  entrySetTyped () const
  The typed version of the method Map::entrySet.
virtual EntrySet::Handle  entrySetTyped ()
  The typed version of the method Map::entrySet.
virtual Set::View  entrySet () const
  Return a set of the mappings contained in this map.

Each element in the returned set is a Map::Entry::View. 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.

Returns:
a set of the mappings contained in this map.

virtual Set::Handle  entrySet ()
  Return a set of the mappings contained in this map.

Each element in the returned set is a Map::Entry::Handle. 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.

Returns:
a set of the mappings contained in this map.


Protected Member Functions

  TypedMap (Map::Holder ohMapDelegate)
  Create a new TypedMap over the given Map.
  TypedMap (const TypedMap &that)
  Copy constructor.

Protected Attributes

FinalView
< EntryConverter
m_vConverter
  The converter used to convert untyped entries to typed ones.

Classes

class   EntryConverter
  A converter from untyped to typed entries: Map::Entry -> TypedEntry. More...

Member Typedef Documentation

typedef K KeyType

The type of the map's keys, e.g.

String::View.

typedef V ValueType

The type of the map's values, e.g.

String::View.


Constructor & Destructor Documentation

TypedMap ( Map::Holder  ohMapDelegate  )  [inline, protected]

Create a new TypedMap over the given Map.

Parameters:
ohMapDelegate  the Map to delegate to

Member Function Documentation

virtual bool containsKey ( KeyType  vKey  )  const [inline, virtual]

The typed version of the method Map::containsKey.

Return true if this map contains a mapping for the specified key.

Parameters:
vKey  key whose presence in this map is to be tested.
Returns:
true if this map contains a mapping for the specified key.

virtual bool containsValue ( ValueType  ohValue  )  const [inline, virtual]

The typed version of the method Map::containsValue.

Return true if this map maps one or more keys to the specified value.

Parameters:
ohValue  value whose presence in this map is to be tested.
Returns:
true if this map maps one or more keys to the specified value.

virtual ValueType get ( KeyType  vKey  )  const [inline, virtual]

The typed version of the method Map::get.

Return the value to which this map maps the specified key, if any.

Parameters:
vKey  key whose associated value is to be returned.
Returns:
the value to which this map maps the specified key, or NULL if the map contains no mapping for this key.
Exceptions:
ClassCastException  if the typed map is broken by external usage

virtual ValueType get ( KeyType  vKey  )  [inline, virtual]

The typed version of the method Map::get.

Return the value to which this map maps the specified key, if any.

Parameters:
vKey  key whose associated value is to be returned.
Returns:
the value to which this map maps the specified key, or NULL if the map contains no mapping for this key.
Exceptions:
ClassCastException  if the typed map is broken by external usage

virtual ValueType put ( KeyType  vKey,
ValueType  ohValue  
) [inline, virtual]

The typed version of the method Map::put.

Associate the specified value with the specified key in this map.

Parameters:
vKey  key with which the specified value is to be associated.
ohValue  value to be associated with the specified key.
Returns:
previous value associated with specified key, or NULL if there was no mapping for key. A NULL return can also indicate that the map previously associated NULL with the specified key.
Exceptions:
coherence::lang::UnsupportedOperationException  if the put() operation is not supported by this map
ClassCastException  if the typed map is broken by external usage

virtual ValueType remove ( KeyType  vKey  )  [inline, virtual]

The typed version of the method Map::put.

Remove the mapping for this key from this map if it is present.

Parameters:
vKey  key whose mapping is to be removed from the map.
Returns:
previous value associated with specified key, or NULL if there was no mapping for key.
Exceptions:
coherence::lang::UnsupportedOperationException  if the remove() operation is not supported by this map
ClassCastException  if the typed map is broken by external usage

virtual void putAll ( typename TypedMap< K, V >::View  vMap  )  [inline, virtual]

The typed version of the method Map::putAll.

Copy all of the mappings from the specified typed map to this map.

Parameters:
vMap  mappings to be stored in this map.
Exceptions:
coherence::lang::UnsupportedOperationException  if the put() operation is not supported by this map

Reimplemented from WrapperCollections::AbstractWrapperMap.

virtual KeySet::View keySetTyped (  )  const [inline, virtual]

The typed version of the method Map::keySet.

Return a typed set view of the keys contained in this map.

Returns:
a typed set view of the keys contained in this map.

virtual KeySet::Handle keySetTyped (  )  [inline, virtual]

The typed version of the method Map::keySet.

Return a typed set view of the keys contained in this map.

Returns:
a typed set view of the keys contained in this map.

virtual ValueCollection::View valuesTyped (  )  const [inline, virtual]

The typed version of the method Map::values.

Return a typed collection view of the values contained in this map.

Returns:
a typed collection view of the values contained in this map.

virtual ValueCollection::Handle valuesTyped (  )  [inline, virtual]

The typed version of the method Map::values.

Return a typed collection view of the values contained in this map.

Returns:
a typed collection view of the values contained in this map.

virtual EntrySet::View entrySetTyped (  )  const [inline, virtual]

The typed version of the method Map::entrySet.

Return a typed set view of the mappings contained in this map.

Returns:
a typed set view of the mappings contained in this map.

virtual EntrySet::Handle entrySetTyped (  )  [inline, virtual]

The typed version of the method Map::entrySet.

Return a typed set view of the mappings contained in this map.

Returns:
a typed set view of the mappings contained in this map.

The documentation for this class was generated from the following file:
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.