Oracle Coherence for C++ API
Release 3.6.1.0
E18813-01

coherence/util/extractor/IdentityExtractor.hpp

/*
* IdentityExtractor.hpp
*
* Copyright (c) 2000, 2010, 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_IDENTITY_EXTRACTOR_HPP
#define COH_IDENTITY_EXTRACTOR_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/util/extractor/AbstractExtractor.hpp"

COH_OPEN_NAMESPACE3(coherence,util,extractor)

using coherence::io::pof::PofReader;
using coherence::io::pof::PofWriter;


/**
* Trivial ValueExtractor implementation that does not actually extract
* anything from the passed value, but returns the value itself.
*
* @author djl  2008.03.05
*/
class COH_EXPORT IdentityExtractor
    : public class_spec<IdentityExtractor,
        extends<AbstractExtractor> >
    {
    friend class factory<IdentityExtractor>;

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

    protected:
        /**
        * Create and return a Handle to a new Object instance.
        */
        IdentityExtractor();


    // ----- ValueExtractor interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual Object::Holder extract(Object::Holder ohTarget) 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;

        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- constants ------------------------------------------------------

    public:
        /**
        * An instance of the IdentityExtractor.
        */
        static IdentityExtractor::Handle getInstance();
    };

COH_CLOSE_NAMESPACE3

#endif // COH_IDENTITY_EXTRACTOR_HPP

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