coherence/lang/interface_spec.hpp

/*
* interface_spec.hpp
*
* Copyright (c) 2000, 2009, 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_INTERFACE_SPEC_HPP
#define COH_INTERFACE_SPEC_HPP

#include "coherence/lang/compatibility.hpp"

#include "coherence/lang/lang_spec.hpp"
#include "coherence/lang/Object.hpp"
#include "coherence/lang/TypedHandle.hpp"
#include "coherence/lang/TypedHolder.hpp"

COH_OPEN_NAMESPACE2(coherence,lang)

/**
* Helper for defining a managed interface.
*
* Managed interfaces virtually derive from coherence::lang::Object, and
* include a set of well known features, which are auto-generated by this
* helper class:
*
* - Handle/View/Holder definitions
* - virtual interface inheritance of up to 16 interfaces
*
* The template takes two parameters:
*
* - The name of the interface being defined
* - An optional list of interfaces to extend, indicated as
*   implements<i1, i2, ...>
*
* A normal interface definition would be:
* @code
* class MyInterface
*   : public interface_spec<MyInterface,
*       implements<SomeInterface, SomeOtherInterface> >
*   {
*   public:
*       // pure virtual method definitions....
*   };
* @endcode
*
* @see implements
*
* @author mf 2008.07.14
*/
template<class T, class I = implements<> >
class interface_spec
    : public virtual Object, public virtual I::implements_chain
    {
    public:
        /**
        * Specification definition
        */
        typedef interface_spec this_spec;

        /**
        * Standard Handle definition
        */
        typedef TypedHandle<T> Handle;

        /**
        * Standard View definition
        */
        typedef TypedHandle<const T> View;

        /**
        * Standard Holder definition
        */
        typedef TypedHolder<T> Holder;

    private:
        /**
        * Blocked Object::create()
        *
        * @internal
        */
        static void create()
            {
            }
    };

COH_CLOSE_NAMESPACE2

#endif // COH_INTERFACE_SPEC_HPP

Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.