00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_POF_REFLECT_CODEC_HPP 00008 #define COH_POF_REFLECT_CODEC_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/io/pof/PofReader.hpp" 00013 #include "coherence/io/pof/PofWriter.hpp" 00014 00015 using coherence::io::pof::PofReader; 00016 using coherence::io::pof::PofWriter; 00017 00018 COH_OPEN_NAMESPACE4(coherence,io,pof,reflect) 00019 00020 /** 00021 * A Codec provides an interception point for any specific code that needs to 00022 * be executed pre or post (de)serialization. In the case of deserialization 00023 * this could be to return a concrete implementation and with serialization 00024 * this could be to explicitly call a specific method on PofWriter 00025 * that is not carried out by PofWriter::writeObject. 00026 * 00027 * @author hr 2011.06.29 00028 * 00029 * @since 3.7.1 00030 */ 00031 class COH_EXPORT Codec 00032 : public interface_spec<Codec> 00033 { 00034 public: 00035 /** 00036 * Deserialize an object from the provided PofReader. Implementing 00037 * this interface allows introducing specific return implementations. 00038 * 00039 * @param hIn the PofReader to read from 00040 * @param nIndex the index of the POF property to deserialize 00041 * 00042 * @return a specific implementation of the POF property 00043 * 00044 * @throws IOException if an I/O error occurs 00045 */ 00046 virtual Object::Holder decode(PofReader::Handle hIn, int32_t nIndex) const = 0; 00047 00048 /** 00049 * Serialize an object using the provided PofWriter. 00050 * 00051 * @param hOut the PofWriter to read from 00052 * @param nIndex the index of the POF property to serialize 00053 * @param v the value to serialize 00054 * 00055 * @throws IOException if an I/O error occurs 00056 */ 00057 virtual void encode(PofWriter::Handle hOut, int32_t nIndex, Object::View v) const = 0; 00058 }; 00059 00060 COH_CLOSE_NAMESPACE4 00061 00062 #endif /* COH_POF_REFLECT_CODEC_HPP */