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

coherence/util/processor/ConditionalPutAll.hpp

/*
* ConditionalPutAll.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_CONDITIONAL_PUT_ALL_HPP
#define COH_CONDITIONAL_PUT_ALL_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/Filter.hpp"
#include "coherence/util/InvocableMap.hpp"
#include "coherence/util/Map.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::Filter;
using coherence::util::InvocableMap;
using coherence::util::Map;


/**
* ConditionalPutAll is an EntryProcessor that performs a
* InvocableMap::Entry#setValue Entry.setValue} operation for multiple entries
* that satisfy the specified condition.
*
* @author tb  2008.04.28
*/
class COH_EXPORT ConditionalPutAll
    : public class_spec<ConditionalPutAll,
        extends<AbstractProcessor>,
        implements<PortableObject> >
    {
    friend class factory<ConditionalPutAll>;

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

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

        /**
        * Construct a ConditionalPutAll processor that updates an entry with
        * a new value if and only if the filter applied to the entry
        * evaluates to true. The new value is extracted from the specified
        * map based on the entry's key.
        *
        * @param vFilter  the filter to evaluate all supplied entries
        * @param vMap     a map of values to update entries with
        */
        ConditionalPutAll(Filter::View vFilter, Map::View vMap);


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

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

        /**
        * {@inheritDoc}
        */
        virtual Map::View processAll(Set::View vsetEntries) 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 filter.
        */
        MemberView<Filter> m_vFilter;

        /**
        * Specifies the map of new values.
        */
        MemberView<Map> m_vMap;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_CONDITIONAL_PUT_ALL_HPP

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