C++ Client API Reference for Oracle Coherence: coherence/lang/interface

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_INTERFACE_SPEC_HPP
00008 #define COH_INTERFACE_SPEC_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/lang_spec.hpp"
00013 #include "coherence/lang/Object.hpp"
00014 #include "coherence/lang/TypedHandle.hpp"
00015 #include "coherence/lang/TypedHolder.hpp"
00016 
00017 COH_OPEN_NAMESPACE2(coherence,lang)
00018 
00019 /**
00020 * Helper for defining a managed interface.
00021 *
00022 * Managed interfaces virtually derive from coherence::lang::Object, and
00023 * include a set of well known features, which are auto-generated by this
00024 * helper class:
00025 *
00026 * - Handle/View/Holder definitions
00027 * - virtual interface inheritance of up to 16 interfaces
00028 *
00029 * The template takes two parameters:
00030 *
00031 * - The name of the interface being defined
00032 * - An optional list of interfaces to extend, indicated as
00033 *   implements<i1, i2, ...>
00034 *
00035 * A normal interface definition would be:
00036 * @code
00037 * class MyInterface
00038 *   : public interface_spec<MyInterface,
00039 *       implements<SomeInterface, SomeOtherInterface> >
00040 *   {
00041 *   public:
00042 *       // pure virtual method definitions....
00043 *   };
00044 * @endcode
00045 *
00046 * @see implements
00047 *
00048 * @author mf 2008.07.14
00049 */
00050 template<class T, class I = implements<> >
00051 class interface_spec
00052     : public virtual Object, public virtual I::implements_chain
00053     {
00054     public:
00055         /**
00056         * Specification definition
00057         */
00058         typedef interface_spec this_spec;
00059 
00060         /**
00061         * Standard Handle definition
00062         */
00063         typedef TypedHandle<T> Handle;
00064 
00065         /**
00066         * Standard View definition
00067         */
00068         typedef TypedHandle<const T> View;
00069 
00070         /**
00071         * Standard Holder definition
00072         */
00073         typedef TypedHolder<T> Holder;
00074 
00075         /**
00076          * implemented interface typedefs
00077          */
00078         typedef typename I::interface_1  interface_1;
00079         typedef typename I::interface_2  interface_2;
00080         typedef typename I::interface_3  interface_3;
00081         typedef typename I::interface_4  interface_4;
00082         typedef typename I::interface_5  interface_5;
00083         typedef typename I::interface_6  interface_6;
00084         typedef typename I::interface_7  interface_7;
00085         typedef typename I::interface_8  interface_8;
00086         typedef typename I::interface_9  interface_9;
00087         typedef typename I::interface_10 interface_10;
00088         typedef typename I::interface_11 interface_11;
00089         typedef typename I::interface_12 interface_12;
00090         typedef typename I::interface_13 interface_13;
00091         typedef typename I::interface_14 interface_14;
00092         typedef typename I::interface_15 interface_15;
00093         typedef typename I::interface_16 interface_16;
00094 
00095         COH_GENERATE_CLASS_ID(T)
00096 
00097     private:
00098         /**
00099         * Blocked Object::create()
00100         *
00101         * @internal
00102         */
00103         static void create()
00104             {
00105             }
00106 
00107         /**
00108          * Hide Object::super.
00109          *
00110          * This will force a compiler error if an interface_spec is used in an extends<> rather then an implements<>
00111          */
00112         typedef void super;
00113     };
00114 
00115 COH_CLOSE_NAMESPACE2
00116 
00117 #endif // COH_INTERFACE_SPEC_HPP
coherence/lang/interface_spec.hpp
