Oracle Coherence for C++ API
Release 3.7.1.0
E22845-01

coherence/util/processor/UpdaterProcessor.hpp

/*
* UpdaterProcessor.hpp
*
* Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_UPDATER_PROCESSOR_HPP
#define COH_UPDATER_PROCESSOR_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/io/pof/PortableObject.hpp"
#include "coherence/util/InvocableMap.hpp"
#include "coherence/util/ValueUpdater.hpp"
#include "coherence/util/processor/AbstractProcessor.hpp"

COH_OPEN_NAMESPACE3(coherence,util, processor)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;
using coherence::io::pof::PortableObject;
using coherence::util::InvocableMap;
using coherence::util::ValueUpdater;


/**
* UpdaterProcessor is an EntryProcessor implementations that updates an
* attribute of an object cached in an InvocableMap.
*
* @author tb  2008.04.28
*/
class COH_EXPORT UpdaterProcessor
    : public class_spec<UpdaterProcessor,
        extends<AbstractProcessor>,
        implements<PortableObject> >
    {
    friend class factory<UpdaterProcessor>;

    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Construct a UpdaterProcessor.
        */
        UpdaterProcessor();

        /**
        * Construct an UpdaterProcessor based on the specified ValueUpdater.
        *
        * @param vUpdater  a ValueUpdater object; passing null will simpy
        *                  replace the entry's value with the specified one
        *                  instead of updating it
        * @param hValue    the value to update the target entry with
        */
        UpdaterProcessor(ValueUpdater::View vUpdater, Object::Holder hValue);


    // ----- InvocableMap::EntryProcessor interface -------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual Object::Holder process(InvocableMap::Entry::Handle hEntry) const;


    // ----- PortableObject interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void readExternal(PofReader::Handle hIn);

        /**
        * {@inheritDoc}
        */
        virtual void writeExternal(PofWriter::Handle hOut) const;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View v) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * The underlying ValueUpdater.
        */
        MemberView<ValueUpdater> m_vUpdater;

        /**
        * A value to update the entry's value with.
        */
        MemberHolder<Object> m_hValue;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_UPDATER_PROCESSOR_HPP

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