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_PORTABLE_PROPERTY_HPP 00008 #define COH_PORTABLE_PROPERTY_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/io/pof/reflect/Codec.hpp" 00013 00014 COH_OPEN_NAMESPACE4(coherence,io,pof,annotation) 00015 00016 /** 00017 * A PortableProperty marks a method accessor as a POF serialized 00018 * attribute. Whilst the PortableProperty::getIndex() and 00019 * PortableProperty::getCodec() can be explicitly specified they can be 00020 * determined by classes that use this annotation. Hence these attributes 00021 * serve as hints to the underlying parser. 00022 * 00023 * @author hr 2011.06.29 00024 * 00025 * @since 3.7.1 00026 */ 00027 class COH_EXPORT PortableProperty 00028 : public class_spec<PortableProperty, 00029 extends<Object>, 00030 implements<Annotation> > 00031 { 00032 friend class factory<PortableProperty>; 00033 00034 // ----- constructors --------------------------------------------------- 00035 00036 protected: 00037 PortableProperty(int32_t nIndex = -1, Class::View vCodec = NULL); 00038 00039 // ----- Annotation methods --------------------------------------------- 00040 00041 public: 00042 /** 00043 * {@inheritDoc} 00044 */ 00045 virtual Class::View annotationType() const; 00046 00047 // ----- PortableProperty methods --------------------------------------- 00048 00049 public: 00050 /** 00051 * The index of this property. 00052 * 00053 * @see PofWriter 00054 * 00055 * @return POF index 00056 */ 00057 virtual int32_t getIndex() const; 00058 00059 /** 00060 * A codec to use to short-circuit determining the type via the 00061 * method return type. 00062 * 00063 * This could be used to determine concrete implementations of 00064 * interfaces, i.e. when the method return is a Map this type 00065 * definition could instruct the code to utilize a LinkedHashMap. 00066 * 00067 * @return class representing the codec to use for this property 00068 */ 00069 virtual Class::View getCodec() const; 00070 00071 // ----- static functions ----------------------------------------------- 00072 00073 public: 00074 /** 00075 * A convenience static method to return a reference to the Class 00076 * definition for this PortableProperty annotation class. 00077 */ 00078 static Class::View getStaticClass(); 00079 00080 // ----- data members --------------------------------------------------- 00081 00082 private: 00083 /** 00084 * The POF index used for serialization and deserialization by 00085 * PofAnnotationSerializer. 00086 */ 00087 int32_t m_nIndex; 00088 00089 /** 00090 * A Class representing a Codec implementation. 00091 */ 00092 FinalView<Class> f_vClzCodec; 00093 }; 00094 00095 COH_CLOSE_NAMESPACE4 00096 00097 #endif /* COH_PORTABLE_PROPERTY_HPP */