coherence/lang/abstract_spec.hpp

/*
* abstract_spec.hpp
*
* Copyright 2001-2008 by Oracle. 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_ABSTRACT_SPEC_HPP
#define COH_ABSTRACT_SPEC_HPP

#include "coherence/lang/compatibility.hpp"

#include "coherence/lang/class_spec.hpp"

COH_OPEN_NAMESPACE2(coherence,lang)

class Object;

/**
* Helper for defining an abstract managed class.
*
* Managed classes are implementations of coherence::lang::Object, and include
* a set of well known features, which are auto-generated by this helper class:
*
* - Handle/View/Holder defintions
* - super class definition
* - virtual interface inheritance of up to 16 interfaces
*
* The template takes three parameters:
*
* - The name of the class being defined
* - The defined classes parent class, indicated as extends<parent>
* - An optional list of interfaces to implement, indicated as
*   implements<i1, i2, ...>
*
* A normal class defintion would be:
* @code
* class Bar
*   : public abstract_spec<Bar,
*       extends<Object>,
*       implements<SomeInterface, SomeOtherInterface> >
*   {
*   public:
*       // normal abstract class definition....
*   };
* @endcode
*
* @see extends
* @see implements
*
* @author mf 2008.07.14
*/
template<class T, class E = extends<Object>, class I = implements<> >
class COH_EXPORT_SPEC abstract_spec
    : public class_spec<T, E, I>
    {
    // ----- typedefs -------------------------------------------------------

    public:
        /**
        * Specification definition
        */
        typedef abstract_spec this_spec;

        /**
        * Definition T's parent class
        */
        typedef abstract_spec super;


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

    protected:
        /**
        * Generate a set of proxy constuctors matching the signatures of the
        * parent class's constructors.
        *
        * NOTE: Compilation errors referencing this line likely indicate that
        *       class being defined by this spec makes calls a "super"
        *       constructor supplying a set of parameters for which there is
        *       no exact match on the parent class.
        */
        COH_DECLARE_PROXY_CONSTRUCTORS(abstract_spec);

    private:
        /**
        * @internal
        *
        * Hide inheirted create methods, as abstract objects cannot be
        * instantiated.
        */
        static void create()
            {
            }

    public:
        /**
        * {@inheritDoc}
        *
        * Pure virtual sizeOf definition ensures that the resulting class is
        * abstract.
        */
        virtual size32_t sizeOf() const = 0;
    };
COH_DEFINE_PROXY_CONSTRUCTORS(COH_TEMPLATE_DECLARE3(T, E, I), \
        COH_TEMPLATE_DEFINE3(T, E, I), abstract_spec, \
        class_spec COH_TEMPLATE_DEFINE3(T, E, I))

COH_CLOSE_NAMESPACE2

#endif // COH_ABSTRACT_SPEC_HPP

Copyright (c) 2000-2008 Oracle. All rights reserved.