C++ Client API Reference for Oracle Coherence: coherence/io/ConfigurableSerializerFactory.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_CONFIGURABLE_SERIALIZER_FACTORY_HPP
00008 #define COH_CONFIGURABLE_SERIALIZER_FACTORY_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/Serializer.hpp"
00013 #include "coherence/io/SerializerFactory.hpp"
00014 #include "coherence/run/xml/XmlConfigurable.hpp"
00015 #include "coherence/run/xml/XmlElement.hpp"
00016 
00017 COH_OPEN_NAMESPACE2(coherence,io)
00018 
00019 using coherence::run::xml::XmlConfigurable;
00020 using coherence::run::xml::XmlElement;
00021 
00022 
00023 /**
00024 * A factory for Serializer objects.
00025 *
00026 * @author wl  2011.11.07
00027 *
00028 * @since Coherence 12.1.2
00029 */
00030 class COH_EXPORT ConfigurableSerializerFactory
00031     : public class_spec<ConfigurableSerializerFactory,
00032         extends<Object>,
00033         implements<SerializerFactory, XmlConfigurable> >
00034     {
00035     friend class factory<ConfigurableSerializerFactory>;
00036 
00037     // ----- constructors ---------------------------------------------------
00038 
00039     protected:
00040         /**
00041         * Create a new ConfigurableSerializerFactory.
00042         *
00043         * @param vXmlConfig  the XML configuration for this
00044         *                    ConfigurableSerializerFactory.
00045         */
00046         ConfigurableSerializerFactory();
00047 
00048 
00049     // ----- ConfigurableSerializerFactory interface ------------------------
00050 
00051     public:
00052         /**
00053         * {@inheritDoc}
00054         */
00055         virtual Serializer::View createSerializer(ClassLoader::View vLoader) const;
00056     
00057 
00058     // ----- XmlConfigurable interface---------------------------------------
00059 
00060     public:
00061         /**
00062         * {@inheritDoc}
00063         */
00064         virtual void setConfig(XmlElement::View xml);
00065 
00066         /**
00067         * {@inheritDoc}
00068         */
00069         virtual XmlElement::View getConfig() const;
00070 
00071 
00072     // ----- Object interface -----------------------------------------------
00073 
00074     public:
00075         /**
00076         * {@inheritDoc}
00077         */
00078         virtual TypedHandle<const String> toString() const;
00079 
00080 
00081     // ---- data members ----------------------------------------------------
00082 
00083     protected:
00084         /**
00085         * XML configuration for this ConfigurableSerializerFactory.
00086         */
00087         FinalView<XmlElement> f_vXmlConfig;
00088     };
00089 
00090 COH_CLOSE_NAMESPACE2
00091 
00092 #endif // COH_CONFIGURABLE_SERIALIZER_FACTORY_HPP