Oracle Coherence for C++ API
Release 3.6.0.0
E15728-01

- Main Page
- Namespaces
- Classes
- Files

# coherence/util/processor/UpdaterProcessor.hpp

    00001 /*
    00002 * UpdaterProcessor.hpp
    00003 *
    00004 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
    00005 *
    00006 * Oracle is a registered trademarks of Oracle Corporation and/or its
    00007 * affiliates.
    00008 *
    00009 * This software is the confidential and proprietary information of Oracle
    00010 * Corporation. You shall not disclose such confidential and proprietary
    00011 * information and shall use it only in accordance with the terms of the
    00012 * license agreement you entered into with Oracle.
    00013 *
    00014 * This notice may not be removed or altered.
    00015 */
    00016 #ifndef COH_UPDATER_PROCESSOR_HPP
    00017 #define COH_UPDATER_PROCESSOR_HPP
    00018
    00019 #include "coherence/lang.ns"
    00020
    00021 #include "coherence/io/pof/PofReader.hpp"
    00022 #include "coherence/io/pof/PofWriter.hpp"
    00023 #include "coherence/io/pof/PortableObject.hpp"
    00024 #include "coherence/util/InvocableMap.hpp"
    00025 #include "coherence/util/ValueUpdater.hpp"
    00026 #include "coherence/util/processor/AbstractProcessor.hpp"
    00027
    00028 COH_OPEN_NAMESPACE3(coherence,util, processor)
    00029
    00030 using coherence::io::pof::PofReader;
    00031 using coherence::io::pof::PofWriter;
    00032 using coherence::io::pof::PortableObject;
    00033 using coherence::util::InvocableMap;
    00034 using coherence::util::ValueUpdater;
    00035
    00036
    00037 /**
    00038 * UpdaterProcessor is an EntryProcessor implementations that updates an
    00039 * attribute of an object cached in an InvocableMap.
    00040 *
    00041 * @author tb  2008.04.28
    00042 */
    00043 class COH_EXPORT UpdaterProcessor
    00044     : public class_spec<UpdaterProcessor,
    00045         extends<AbstractProcessor>,
    00046         implements<PortableObject> >
    00047     {
    00048     friend class factory<UpdaterProcessor>;
    00049
    00050     // ----- constructors ---------------------------------------------------
    00051
    00052     protected:
    00053         /**
    00054         * Construct a UpdaterProcessor.
    00055         */
    00056         UpdaterProcessor();
    00057
    00058         /**
    00059         * Construct an UpdaterProcessor based on the specified ValueUpdater.
    00060         *
    00061         * @param vUpdater  a ValueUpdater object; passing null will simpy
    00062         *                  replace the entry's value with the specified one
    00063         *                  instead of updating it
    00064         * @param hValue    the value to update the target entry with
    00065         */
    00066         UpdaterProcessor(ValueUpdater::View vUpdater, Object::Holder hValue);
    00067
    00068
    00069     // ----- InvocableMap::EntryProcessor interface -------------------------
    00070
    00071     public:
    00072         /**
    00073         * {@inheritDoc}
    00074         */
    00075         virtual Object::Holder process(InvocableMap::Entry::Handle hEntry) const;
    00076
    00077
    00078     // ----- PortableObject interface ---------------------------------------
    00079
    00080     public:
    00081         /**
    00082         * {@inheritDoc}
    00083         */
    00084         virtual void readExternal(PofReader::Handle hIn);
    00085
    00086         /**
    00087         * {@inheritDoc}
    00088         */
    00089         virtual void writeExternal(PofWriter::Handle hOut) const;
    00090
    00091
    00092     // ----- Object interface -----------------------------------------------
    00093
    00094     public:
    00095         /**
    00096         * {@inheritDoc}
    00097         */
    00098         virtual bool equals(Object::View v) const;
    00099
    00100         /**
    00101         * {@inheritDoc}
    00102         */
    00103         virtual size32_t hashCode() const;
    00104
    00105
    00106     // ----- data members ---------------------------------------------------
    00107
    00108     protected:
    00109         /**
    00110         * The underlying ValueUpdater.
    00111         */
    00112         MemberView<ValueUpdater> m_vUpdater;
    00113
    00114         /**
    00115         * A value to update the entry's value with.
    00116         */
    00117         MemberHolder<Object> m_hValue;
    00118     };
    00119
    00120 COH_CLOSE_NAMESPACE3
    00121
    00122 #endif // COH_UPDATER_PROCESSOR_HPP

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.