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

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_IDENTITY_EXTRACTOR_HPP
00008 #define COH_IDENTITY_EXTRACTOR_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/util/extractor/AbstractExtractor.hpp"
00015 
00016 COH_OPEN_NAMESPACE3(coherence,util,extractor)
00017 
00018 using coherence::io::pof::PofReader;
00019 using coherence::io::pof::PofWriter;
00020 
00021 
00022 /**
00023 * Trivial ValueExtractor implementation that does not actually extract
00024 * anything from the passed value, but returns the value itself.
00025 *
00026 * @author djl  2008.03.05
00027 */
00028 class COH_EXPORT IdentityExtractor
00029     : public class_spec<IdentityExtractor,
00030         extends<AbstractExtractor> >
00031     {
00032     friend class factory<IdentityExtractor>;
00033 
00034     // ----- constructors ---------------------------------------------------
00035 
00036     protected:
00037         /**
00038         * Create and return a Handle to a new Object instance.
00039         */
00040         IdentityExtractor();
00041 
00042 
00043     // ----- ValueExtractor interface ---------------------------------------
00044 
00045     public:
00046         /**
00047         * {@inheritDoc}
00048         */
00049         virtual Object::Holder extract(Object::Holder ohTarget) const;
00050 
00051 
00052     // ----- PortableObject interface ---------------------------------------
00053 
00054     public:
00055         /**
00056         * {@inheritDoc}
00057         */
00058         virtual void readExternal(PofReader::Handle hIn);
00059 
00060         /**
00061         * {@inheritDoc}
00062         */
00063         virtual void writeExternal(PofWriter::Handle hOut) const;
00064 
00065 
00066     // ----- Object interface -----------------------------------------------
00067 
00068     public:
00069         /**
00070         * {@inheritDoc}
00071         */
00072         virtual bool equals(Object::View v) const;
00073 
00074         /**
00075         * {@inheritDoc}
00076         */
00077         virtual size32_t hashCode() const;
00078 
00079         /**
00080         * {@inheritDoc}
00081         */
00082         virtual TypedHandle<const String> toString() const;
00083 
00084 
00085     // ----- constants ------------------------------------------------------
00086 
00087     public:
00088         /**
00089         * An instance of the IdentityExtractor.
00090         */
00091         static IdentityExtractor::Handle getInstance();
00092     };
00093 
00094 COH_CLOSE_NAMESPACE3
00095 
00096 #endif // COH_IDENTITY_EXTRACTOR_HPP