C++ Client API Reference for Oracle Coherence: coherence/lang/Reference.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_REFERENCE_HPP
00008 #define COH_REFERENCE_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/interface_spec.hpp"
00013 #include "coherence/lang/Object.hpp"
00014 #include "coherence/lang/TypedHandle.hpp"
00015 
00016 COH_OPEN_NAMESPACE2(coherence,lang)
00017 
00018 
00019 /**
00020 * Reference provides an additional level of indirection to object instances.
00021 *
00022 * It is not a general use class, but rather it is a building block for such
00023 * things as WeakReference.
00024 *
00025 * @author mf  2008.04.10
00026 */
00027 class COH_EXPORT Reference
00028     : public interface_spec<Reference>
00029     {
00030     // ----- Reference interface --------------------------------------------
00031 
00032     public:
00033         /**
00034         * Set the referenced Object.
00035         *
00036         * @param oh  the Object to reference
00037         */
00038         virtual void set(Object::Holder oh) = 0;
00039 
00040         /**
00041         * Return a Holder to the referenced Object.
00042         *
00043         * @return a Holder to the referenced Object
00044         */
00045         virtual Object::Holder get() const = 0;
00046 
00047         /**
00048         * Return a Holder to the referenced Object.
00049         *
00050         * @return a Holder to the referenced Object
00051         */
00052         virtual Object::Holder get() = 0;
00053     };
00054 
00055 COH_CLOSE_NAMESPACE2
00056 
00057 #endif // COH_REFERENCE_HPP