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_SERIALIZER_HPP 00008 #define COH_POF_SERIALIZER_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 COH_OPEN_NAMESPACE3(coherence,io,pof) 00013 00014 class PofReader; 00015 class PofWriter; 00016 00017 00018 /** 00019 * The PofSerializer interface provides the capability of reading and writing 00020 * an object from and to a Portable Object Format (POF) stream. 00021 * 00022 * @author jh 2008.01.14 00023 */ 00024 class COH_EXPORT PofSerializer 00025 : public interface_spec<PofSerializer> 00026 { 00027 // ----- handle definitions --------------------------------------------- 00028 00029 public: 00030 /** 00031 * PofReader Handle definition. 00032 */ 00033 typedef TypedHandle<PofReader> PofReaderHandle; 00034 00035 /** 00036 * PofWriter Handle definition. 00037 */ 00038 typedef TypedHandle<PofWriter> PofWriterHandle; 00039 00040 00041 // ----- PofSerializer interface ---------------------------------------- 00042 00043 public: 00044 /** 00045 * Serialize a user type instance to a POF stream by writing its state 00046 * using the specified PofWriter. 00047 * 00048 * An implementation of PofSerializer is required to follow the 00049 * following steps in sequence for writing out an Object of a user 00050 * type: 00051 * <ol> 00052 * <li>If the object is Evolvable, the implementation must set the 00053 * version by calling PofWriter::setVersionId().</li> 00054 * <li>The implementation may write any combination of the properties 00055 * of the user type by using the "write" methods of the PofWriter, 00056 * but it must do so in the order of the property indexes.</li> 00057 * <li>After all desired properties of the user type have been 00058 * written, the implementation must terminate the writing of 00059 * the user type by calling PofWriter::writeRemainder(). </li> 00060 * </ol> 00061 * 00062 * @param hOut a PofWriter to use for writing the object's state 00063 * @param v an object to serialize 00064 */ 00065 virtual void serialize(PofWriterHandle hOut, Object::View v) const = 0; 00066 00067 /** 00068 * Deserialize a user type instance from a POF stream by reading its 00069 * state using the specified PofReader. 00070 * 00071 * An implementation of PofSerializer is required to follow the 00072 * following steps in sequence for reading in an object of a user 00073 * type: 00074 * <ol> 00075 * <li>If the object is Evolvable, the implementation must get the 00076 * version by calling PofWriter::getVersionId().</li> 00077 * <li>The implementation may read any combination of the properties 00078 * of the user type by using "read" methods of the PofReader, but 00079 * it must do so in the order of the property indexes.</li> 00080 * <li>After all desired properties of the user type have been read, 00081 * the implementation must terminate the reading of the user type 00082 * by calling PofReader::readRemainder().</li> 00083 * </ol> 00084 * 00085 * @param hIn a PofReader to use for reading the Object's state 00086 * 00087 * @return the deserialized user type instance 00088 */ 00089 virtual Object::Holder deserialize(PofReaderHandle hIn) const = 0; 00090 }; 00091 00092 COH_CLOSE_NAMESPACE3 00093 00094 #endif // COH_POF_SERIALIZER_HPP