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_ANNOTATION_SERIALIZER_HPP 00008 #define COH_POF_ANNOTATION_SERIALIZER_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/io/pof/PofReader.hpp" 00013 #include "coherence/io/pof/PofSerializer.hpp" 00014 #include "coherence/io/pof/PofWriter.hpp" 00015 00016 COH_OPEN_NAMESPACE3(coherence,io,pof) 00017 00018 /** 00019 * A PofAnnotationSerializer provides annotation based (de)serialization. 00020 * This serializer must be instantiated with the intended class which is 00021 * eventually scanned for the presence of the following annotations. 00022 * <ul> 00023 * <li>coherence::io::pof::annotation::Portable</li> 00024 * <li>coherence::io::pof::annotation::PortableProperty</li> 00025 * </ul> 00026 * 00027 * This serializer supports classes iff they are annotated with the type level 00028 * annotation; Portable. This annotation is a marker indicating the ability 00029 * to (de)serialize using this serializer. 00030 * 00031 * All methods annotated with PortableProperty are explicitly 00032 * deemed POF serializable with the option of specifying overrides to 00033 * provide explicit behaviour such as: 00034 * <ul> 00035 * <li>explicit POF indexes</li> 00036 * <li>Custom coherence::io::pof::reflect::Codec to 00037 * specify concrete implementations / customizations</li> 00038 * </ul> 00039 * 00040 * The PortableProperty::getIndex() (POF index) can be omitted iff the 00041 * auto-indexing feature is enabled. This is enabled by instantiating this 00042 * class with the \c fAutoIndex constructor argument. This feature 00043 * determines the index based on any explicit indexes specified and the name 00044 * of the portable properties. Currently objects with multiple versions is 00045 * not supported. The following illustrates the auto index algorithm: 00046 * <table border=1> 00047 * <tr><td>Name</td><td>Explicit Index</td><td>Determined Index</td></tr> 00048 * <tr><td>c</td><td>1</td><td>1</td> 00049 * <tr><td>a</td><td></td><td>0</td> 00050 * <tr><td>b</td><td></td><td>2</td> 00051 * </table> 00052 * 00053 * <b>NOTE:</b> This implementation does support objects that implement 00054 * Evolvable. 00055 * 00056 * @author hr 2011.06.29 00057 * 00058 * @since 3.7.1 00059 * 00060 * @see COH_REGISTER_TYPED_CLASS 00061 * @see COH_REGISTER_POF_ANNOTATED_CLASS 00062 * @see COH_REGISTER_POF_ANNOTATED_CLASS_AI 00063 * @see Portable 00064 */ 00065 class COH_EXPORT PofAnnotationSerializer 00066 : public class_spec<PofAnnotationSerializer, 00067 extends<Object>, 00068 implements<PofSerializer> > 00069 { 00070 friend class factory<PofAnnotationSerializer>; 00071 00072 // ----- constructors --------------------------------------------------- 00073 00074 protected: 00075 /** 00076 * Constructs a PofAnnotationSerializer. 00077 * 00078 * @param nTypeId the POF type id 00079 * @param vClz type this serializer is aware of 00080 * @param fAutoIndex turns on the auto index feature, default = false 00081 */ 00082 PofAnnotationSerializer(int32_t nTypeId, Class::View vClz, bool fAutoIndex = false); 00083 00084 // ----- PofSerializer interface ---------------------------------------- 00085 00086 public: 00087 /** 00088 * {@inheritDoc} 00089 */ 00090 virtual void serialize(PofWriter::Handle hOut, Object::View v) const; 00091 00092 /** 00093 * {@inheritDoc} 00094 */ 00095 virtual Object::Holder deserialize(PofReader::Handle hIn) const; 00096 00097 // ---- helpers --------------------------------------------------------- 00098 00099 protected: 00100 /** 00101 * Initialize this class based on the provided information. 00102 * 00103 * @param nTypeId the POF type id 00104 * @param vClz type this serializer is aware of 00105 * @param fAutoIndex turns on the auto index feature 00106 */ 00107 virtual void initialize(int32_t nTypeId, Class::View vClz, bool fAutoIndex); 00108 00109 // ---- data members ---------------------------------------------------- 00110 00111 private: 00112 /** 00113 * A structural definition of the type information. 00114 */ 00115 FinalHandle<Object> f_ohTypeMetadata; 00116 }; 00117 00118 COH_CLOSE_NAMESPACE3 00119 00120 #endif // COH_POF_ANNOTATION_SERIALIZER_HPP