C++ API Reference for Oracle® Coherence Community Edition
(14.1.1.0.1)
F23533-01
coherence::io::pof::reflect::Codec

Codec Class Reference

#include <coherence/io/pof/reflect/Codec.hpp>

Inherits Object.

Inherited by Codecs::AbstractCodec [virtual].

List of all members.

Detailed Description

A Codec provides an interception point for any specific code that needs to be executed pre or post (de)serialization.

In the case of deserialization this could be to return a concrete implementation and with serialization this could be to explicitly call a specific method on PofWriter that is not carried out by PofWriter::writeObject.

Author:
hr 2011.06.29
Since:
3.7.1

Public Types

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

Public Member Functions

virtual Object::Holder decode (PofReader::Handle hIn, int32_t nIndex) const =0
 Deserialize an object from the provided PofReader.
virtual void encode (PofWriter::Handle hOut, int32_t nIndex, Object::View v) const =0
 Serialize an object using the provided PofWriter.

Member Function Documentation

virtual Object::Holder decode ( PofReader::Handle  hIn,
int32_t  nIndex 
) const [pure virtual]

Deserialize an object from the provided PofReader.

Implementing this interface allows introducing specific return implementations.

Parameters:
hIn the PofReader to read from
nIndex the index of the POF property to deserialize
Returns:
a specific implementation of the POF property
Exceptions:
IOException if an I/O error occurs

Implemented in Codecs::DefaultCodec.

virtual void encode ( PofWriter::Handle  hOut,
int32_t  nIndex,
Object::View  v 
) const [pure virtual]

Serialize an object using the provided PofWriter.

Parameters:
hOut the PofWriter to read from
nIndex the index of the POF property to serialize
v the value to serialize
Exceptions:
IOException if an I/O error occurs

Implemented in Codecs::AbstractCodec.

The documentation for this class was generated from the following file:
Copyright © 2000, 2020, Oracle and/or its affiliates. Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.