C++ Client API Reference for Oracle Coherence: coherence/io/pof/ThrowablePofSerializer.hpp Source File

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_THROWABLE_POF_SERIALIZER_HPP
00008 #define COH_THROWABLE_POF_SERIALIZER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PofReader.hpp"
00013 #include "coherence/io/pof/PofWriter.hpp"
00014 #include "coherence/util/Collection.hpp"
00015 
00016 COH_OPEN_NAMESPACE3(coherence,io,pof)
00017 
00018 using coherence::util::Collection;
00019 
00020 
00021 /**
00022 * PofSerializer implementation that can serialize and deserialize an
00023 * Exception to/from a POF stream.
00024 *
00025 * This serializer is provides a catch-all mechanism for serializing exceptions.
00026 * Any deserialized exception will loose type information, and simply be
00027 * represented as a PortableException.  The basic detail information of the
00028 * exception are retained.
00029 *
00030 * PortableException and this class work asymmetricly to provide the
00031 * serialization routines for exceptions.
00032 *
00033 * @author mf  2008.08.25
00034 */
00035 class COH_EXPORT ThrowablePofSerializer
00036     : public class_spec<ThrowablePofSerializer,
00037         extends<Object>,
00038         implements<PofSerializer> >
00039     {
00040     friend class factory<ThrowablePofSerializer>;
00041 
00042     // ----- constructors ---------------------------------------------------
00043 
00044     protected:
00045         /**
00046         * Default constructor.
00047         */
00048         ThrowablePofSerializer();
00049 
00050 
00051     // ----- PofSerializer interface ----------------------------------------
00052 
00053     public:
00054         /**
00055         * {@inheritDoc}
00056         */
00057         virtual void serialize(PofWriter::Handle hOut, Object::View v) const;
00058 
00059         /**
00060         * {@inheritDoc}
00061         */
00062         virtual Object::Holder deserialize(PofReader::Handle hIn) const;
00063 
00064 
00065     // ----- helpers --------------------------------------------------------
00066 
00067     public:
00068         /**
00069         * Write the Exception to the specified stream.
00070         *
00071         * @param hOut  the stream to write to
00072         * @param ve    the Exception to write
00073         */
00074         static void writeThrowable(PofWriter::Handle hOut, Exception::View ve);
00075     };
00076 
00077 COH_CLOSE_NAMESPACE3
00078 
00079 #endif // COH_THROWABLE_POF_SERIALIZER_HPP