Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

ConverterCollections::EntryConverter Class Reference

#include <coherence/util/ConverterCollections.hpp>

Inherits Object, and Converter.

List of all members.


Detailed Description

Map::Entry Converter, supporting key and value conversion.
 

Public Types

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

Public Member Functions

 EntryConverter (Converter::View vConvKey, Converter::View vConvVal)
 Create a Map entry Converter.
 EntryConverter (const EntryConverter &that)
 Copy constructor.
virtual Object::Holder convert (Object::Holder oh) const
 Convert an Object referenced by the supplied holder.

Parameters:
 oh the holder to the Object to convert
Returns:
the holder to the converted Object
virtual Converter::View getKeyConverter () const
 
Returns:
a view of the key Converter
virtual Converter::View getValueConverter () const
 
Returns:
a view of the value Converter

Static Public Member Functions

static Converter::View getKeyConverter (EntryConverter::View vConvert)
 
Parameters:
 vConvert the EntryConverter
static Converter::View getValueConverter (EntryConverter::View vConvert)
 
Parameters:
 vConvert the EntryConverter
static Object::View convertKey (EntryConverter::View vConvert, Object::View vKey)
 Convert the key of the map entry referenced by the supplied handle using the supplied EntryConverter.
static Object::Holder convertValue (EntryConverter::View vConvert, Object::Holder ohValue)
 Convert the value of the map entry referenced by the supplied view using the supplied EntryConverter.

Protected Attributes

FinalView< Converterm_vConvKey
 The key Converter.
FinalView< Converterm_vConvVal
 The value Converter.

Constructor & Destructor Documentation

EntryConverter ( Converter::View  vConvKey,
    Converter::View  vConvVal 
  )    

Create a Map entry Converter.

Parameters:
 vConvKey the key Converter
 vConvVal the value Converter


Member Function Documentation

static Converter::View getKeyConverter ( EntryConverter::View  vConvert  )  [static]

Parameters:
 vConvert the EntryConverter

Returns:
a view of the vConvert's key Converter

static Converter::View getValueConverter ( EntryConverter::View  vConvert  )  [static]

Parameters:
 vConvert the EntryConverter

Returns:
a view of the vConvert's value Converter

static Object::View convertKey ( EntryConverter::View  vConvert,
    Object::View  vKey 
  )    [static]

Convert the key of the map entry referenced by the supplied handle using the supplied EntryConverter.

Parameters:
 vConvert a view of the EntryConverter to use
 vKey a view to the key to convert
Returns:
a handle to the key, or the unconverted key if the vConvert is NULL

static Object::Holder convertValue ( EntryConverter::View  vConvert,
    Object::Holder  ohValue 
  )    [static]

Convert the value of the map entry referenced by the supplied view using the supplied EntryConverter.

Parameters:
 vConvert a view of the EntryConverter to use
 ohValue a holder to the value to convert
Returns:
a view of the value, or the unconverted value if the vConvert is NULL


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