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_UPDATER_HPP 00008 #define COH_POF_UPDATER_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/io/pof/PortableObject.hpp" 00015 #include "coherence/io/pof/reflect/PofNavigator.hpp" 00016 #include "coherence/util/ValueUpdater.hpp" 00017 00018 COH_OPEN_NAMESPACE3(coherence,util,extractor) 00019 00020 using coherence::io::pof::PortableObject; 00021 using coherence::io::pof::PofReader; 00022 using coherence::io::pof::PofWriter; 00023 using coherence::io::pof::reflect::PofNavigator; 00024 00025 00026 /** 00027 * POF-based ValueUpdater implementation. 00028 * 00029 * @author as/gm 2009.04.02 00030 * 00031 * @since Coherence 3.5 00032 */ 00033 class COH_EXPORT PofUpdater 00034 : public class_spec<PofUpdater, 00035 extends<Object>, 00036 implements<ValueUpdater, PortableObject> > 00037 { 00038 friend class factory<PofUpdater>; 00039 00040 // ----- constructors --------------------------------------------------- 00041 00042 protected: 00043 /** 00044 * Default constructor (for backward compatibility). 00045 */ 00046 PofUpdater(); 00047 00048 /** 00049 * Constructs a PofUpdater based on a property index. 00050 * <p/> 00051 * This constructor is equivalent to: 00052 * <pre> 00053 * PofUpdater::View vUpdater = 00054 * PofUpdater::create(SimplePofPath::create(iProp)); 00055 * </pre> 00056 * 00057 * @param iProp property index 00058 */ 00059 PofUpdater(int32_t iProp); 00060 00061 /** 00062 * Constructs a PofUpdater based on a property path. 00063 * 00064 * @param vNavigator POF navigator 00065 */ 00066 PofUpdater(PofNavigator::View vNavigator); 00067 00068 00069 // ----- ValueUpdater interface ------------------------------------------ 00070 00071 public: 00072 /** 00073 * Update the passed target object using the specified value. 00074 * <p/> 00075 * It is expected that this updater will only be used against 00076 * POF-encoded entries implementing {@link BinaryEntry} interface. 00077 * 00078 * @param hTarget the Object to update 00079 * @param ohValue the new value to update the target's property with 00080 * 00081 * @throws UnsupportedOperationException if the specified target 00082 * object is not a POF-encoded {@link BinaryEntry} or the 00083 * serializer is not a PofContext 00084 * @throws NullPointerException if the property cannot be resolved 00085 */ 00086 virtual void update(Object::Handle hTarget, 00087 Object::Holder ohValue) const; 00088 00089 00090 // ----- PortableObject interface --------------------------------------- 00091 00092 public: 00093 /** 00094 * {@inheritDoc} 00095 */ 00096 virtual void readExternal(PofReader::Handle hIn); 00097 00098 /** 00099 * {@inheritDoc} 00100 */ 00101 virtual void writeExternal(PofWriter::Handle hOut) const; 00102 00103 00104 // ----- Object interface ----------------------------------------------- 00105 00106 public: 00107 /** 00108 * Compare the PofUpdater with another object to determine 00109 * equality. 00110 * 00111 * @return true iff this PofUpdater and the passed object are 00112 * equivalent PofUpdaters 00113 */ 00114 virtual bool equals(Object::View v) const; 00115 00116 /** 00117 * Determine a hash value for the PofUpdater object according to 00118 * the general {@link Object#hashCode()} contract. 00119 * 00120 * @return an integer hash value for this PofUpdater object 00121 */ 00122 virtual size32_t hashCode() const; 00123 00124 /** 00125 * Return a human-readable description for this PofUpdater. 00126 * 00127 * @return a String description of the PofUpdater 00128 */ 00129 virtual TypedHandle<const String> toString() const; 00130 00131 00132 // ----- data members --------------------------------------------------- 00133 00134 private: 00135 /** 00136 * POF navigator. 00137 */ 00138 FinalView<PofNavigator> f_vNavigator; 00139 }; 00140 00141 COH_CLOSE_NAMESPACE3 00142 00143 #endif // #define COH_POF_UPDATER_HPP