C++ Client API Reference for Oracle Coherence: coherence/util/extractor/UniversalUpdater.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2025, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * https://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_UNIVERSAL_UPDATER_HPP
00008 #define COH_UNIVERSAL_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 
00016 #include "coherence/util/extractor/AbstractUpdater.hpp"
00017 
00018 COH_OPEN_NAMESPACE3(coherence,util,extractor)
00019 
00020 using coherence::io::pof::PofReader;
00021 using coherence::io::pof::PofWriter;
00022 using coherence::io::pof::PortableObject;
00023 
00024 /**
00025  * Universal ValueUpdater implementation.
00026  *
00027  * UniversalUpdater can only run within the Coherence cluster.
00028  *
00029  * Refer to the Coherence for Java documentation for more information.
00030  *
00031  * @author gg 2005.10.27, jf 2017.11.28, phf 2024.09.23
00032  *
00033  * @see CompositeUpdater
00034  *
00035  * @since 14.1.2.0.0
00036  */
00037 class COH_EXPORT UniversalUpdater
00038     : public cloneable_spec<UniversalUpdater,
00039         extends<AbstractUpdater>,
00040         implements<PortableObject> >
00041     {
00042     friend class factory<UniversalUpdater>;
00043 
00044     // ----- constructors ---------------------------------------------------
00045 
00046     protected:
00047         /**
00048          * Construct an empty UniversalUpdater
00049          * (necessary for the PortableObject interface).
00050          */
00051         UniversalUpdater();
00052 
00053         /**
00054          * Construct a UniversalUpdater for the provided name.
00055          *
00056          * @param vsName  a method or property name
00057          */
00058         UniversalUpdater(String::View vsName);
00059 
00060         /**
00061          * Copy constructor.
00062          */
00063         UniversalUpdater(const UniversalUpdater& that);
00064 
00065     // ----- PortableObject interface ---------------------------------------
00066 
00067     public:
00068         /**
00069          * {@inheritDoc}
00070          */
00071         virtual void readExternal(PofReader::Handle hIn);
00072 
00073         /**
00074          * {@inheritDoc}
00075          */
00076         virtual void writeExternal(PofWriter::Handle hOut) const;
00077 
00078     // ----- Object interface -----------------------------------------------
00079 
00080     public:
00081         /**
00082          * {@inheritDoc}
00083          */
00084         virtual TypedHandle<const String> toString() const;
00085 
00086     // ----- data members ---------------------------------------------------
00087 
00088     protected:
00089         /**
00090          * A method name, or a property name.
00091          */
00092         FinalView<String> f_vsName;
00093     };
00094 
00095 COH_CLOSE_NAMESPACE3
00096 
00097 #endif // COH_UNIVERSAL_UPDATER_HPP