Map Class Reference

#include <coherence/util/Map.hpp>

Inherits Object.

Inherited by CacheMap [virtual], AbstractMap [virtual], ConcurrentMap [virtual], InvocableMap [virtual], NullImplementation::NullMap [virtual], ObservableMap [virtual], QueryMap [virtual], and WrapperCollections::AbstractWrapperMap [virtual].

List of all members.


Detailed Description

An interface for associating key value pairs.

See also:
Collection

Set


Public Types

typedef spec::Handle Handle
 Map Handle definition.
typedef spec::View View
 Map View definition.
typedef spec::Holder Holder
 Map Holder definition.

Public Member Functions

virtual size32_t size () const =0
 Return the number of key-value mappings in this map.
virtual bool isEmpty () const =0
 Return true if this map contains no key-value mappings.
virtual bool containsKey (Object::View vKey) const =0
 Return true if this map contains a mapping for the specified key.
virtual bool containsValue (Object::View vValue) const =0
 Return true if this map maps one or more keys to the specified value.
virtual Object::Holder get (Object::View vKey) const =0
 Return the value to which this map maps the specified key.
virtual Object::Holder put (Object::View vKey, Object::Holder ohValue)=0
 Associate the specified value with the specified key in this map.
virtual Object::Holder remove (Object::View vKey)=0
 Remove the mapping for this key from this map if it is present.
virtual void putAll (Map::View vMap)=0
 Copy all of the mappings from the specified map to this map.
virtual void clear ()=0
 Remove all mappings from this map.
virtual Set::View keySet () const =0
 Return a set of the keys contained in this map.
virtual Set::Handle keySet ()=0
 Return a set of the keys contained in this map.
virtual Collection::View values () const =0
 Return a collection of the values contained in this map.
virtual
Collection::Handle 
values ()=0
 Return a collection of the values contained in this map.
virtual Set::View entrySet () const =0
 Return a set of the mappings contained in this map.
virtual Set::Handle entrySet ()=0
 Return a set of the mappings contained in this map.

Classes

class  Entry
 A map entry (key-value pair). More...

Member Function Documentation

virtual size32_t size (  )  const [pure virtual]

Return the number of key-value mappings in this map.

Returns:
the number of key-value mappings in this map.

Implemented in ContinuousQueryCache, AbstractMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual bool isEmpty (  )  const [pure virtual]

Return true if this map contains no key-value mappings.

Returns:
true if this map contains no key-value mappings.

Implemented in AbstractMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual bool containsKey ( Object::View  vKey  )  const [pure virtual]

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.

Implemented in AbstractMap, ConverterCollections::ConverterMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual bool containsValue ( Object::View  vValue  )  const [pure virtual]

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 Map interface.

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

Implemented in AbstractMap, ConverterCollections::ConverterMap, and WrapperCollections::AbstractWrapperMap.

virtual Object::Holder get ( Object::View  vKey  )  const [pure virtual]

Return the value to which this map maps the specified key.

Return NULL if the map contains no mapping for this key. A return value of NULL does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to NULL. The containsKey operation may be used to distinguish these two cases.

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.
See also:
containsKey()

Implemented in ContinuousQueryCache, AbstractMap, ConverterCollections::ConverterMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual Object::Holder put ( Object::View  vKey,
Object::Holder  ohValue 
) [pure virtual]

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

If the map previously contained a mapping for this key, the old value is replaced by the specified value.

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.

Implemented in PofHelper::WriteableEntrySetMap, PofHelper::ReadableEntrySetMap, ContinuousQueryCache, ConverterCollections::ConverterMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual Object::Holder remove ( Object::View  vKey  )  [pure virtual]

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

Return the value to which the map previously associated the key, or NULL if the map contained no mapping for this key. (A NULL return can also indicate that the map previously associated NULL with the specified key.) The map will not contain a mapping for the specified key once the call returns.

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.

Implemented in PofHelper::WriteableEntrySetMap, PofHelper::ReadableEntrySetMap, ContinuousQueryCache, ConverterCollections::ConverterMap, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual void putAll ( Map::View  vMap  )  [pure virtual]

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 k to value v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.

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

Implemented in AbstractMap, ConverterCollections::ConverterMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual void clear (  )  [pure virtual]

Remove all mappings from this map.

Exceptions:
coherence::lang::UnsupportedOperationException if the clear()operation is not supported by this map.

Implemented in PofHelper::WriteableEntrySetMap, PofHelper::ReadableEntrySetMap, ContinuousQueryCache, SafeHashMap, and WrapperCollections::AbstractWrapperMap.

virtual Set::View keySet (  )  const [pure virtual]

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.

Implemented in ContinuousQueryCache, AbstractMap, ConverterCollections::ConverterMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual Set::Handle keySet (  )  [pure virtual]

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.

Implemented in ContinuousQueryCache, AbstractMap, ConverterCollections::ConverterMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual Collection::View values (  )  const [pure virtual]

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.

Implemented in AbstractMap, ConverterCollections::ConverterMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual Collection::Handle values (  )  [pure virtual]

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.

Implemented in AbstractMap, ConverterCollections::ConverterMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual Set::View entrySet (  )  const [pure virtual]

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.

Implemented in PofHelper::WriteableEntrySetMap, PofHelper::ReadableEntrySetMap, ContinuousQueryCache, ConverterCollections::ConverterMap, SafeHashMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.

virtual Set::Handle entrySet (  )  [pure virtual]

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.

Implemented in PofHelper::WriteableEntrySetMap, PofHelper::ReadableEntrySetMap, ContinuousQueryCache, ConverterCollections::ConverterMap, SafeHashMap, TypedCollections::TypedMap, and WrapperCollections::AbstractWrapperMap.


The documentation for this class was generated from the following file: Copyright (c) 2000-2008 Oracle. All rights reserved.