coherence/lang/Class.hpp

/*
* Class.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_CLASS_HPP
#define COH_CLASS_HPP

#include "coherence/lang/compatibility.hpp"

#include "coherence/lang/abstract_spec.hpp"
#include "coherence/lang/MemberView.hpp"
#include "coherence/lang/Object.hpp"
#include "coherence/lang/ObjectArray.hpp"

#include <ostream>
#include <typeinfo>

COH_OPEN_NAMESPACE2(coherence,lang)


/**
* A Class represents a managed object implementation.
*
* Not all managed classes may have a corresponding Class representation.
* Classes are refered to via their demangled RTTI name, for example
* coherence::lang::Object.
*
* Classes can be loaded by name via a ClassLoader.
*
* @see ClassLoader
*
* @author mf  2008.04.03
*/
class COH_EXPORT Class
    : public abstract_spec<Class>
    {
    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Construct a class based on a C++ type_info.
        *
        * @param info the type_info for the class represented by this Class.
        */
        Class(const std::type_info& info);


    // ----- Class interface ------------------------------------------------

    public:
        /**
        * Return the name of the class.
        *
        * @return the class name
        */
        String::View getName() const;

        /**
        * Create a new instance of the corresponding type.
        *
        * @param vaParam the object's initialization parameters
        *
        * @return a new instance of the corresponding type
        */
        virtual Object::Handle newInstance(ObjectArray::View vaParam = NULL) const = 0;

        /**
        * Return the typeinfo for the corresponding type.
        *
        * @return the typeinfo for the corresponding type
        */
        virtual const std::type_info& getTypeInfo() const = 0;

        /**
        * Return the shallow size for an instance of the class represented
        * by this Class.
        *
        * @return the shallow size of an instance of the represented class.
        */
        virtual size32_t getSize() const = 0;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual bool equals(Object::View that) const;

        /**
        * {@inheritDoc}
        */
        virtual size32_t hashCode() const;


    // ----- static helpers -------------------------------------------------

    public:
        /**
        * Return the class name of the supplied Object.
        *
        * @param v  the object instance for which to obtain the class name
        *
        * @return the class name of the supplied Object
        */
        static String::View getClassName(Object::View v);

        /**
        * Return the type name of the supplied Object.
        *
        * @param info  the type id for which to obtain the type name
        *
        * @return the type name of the supplied type
        */
        static String::View getTypeName(const std::type_info& info);


    // ----- data members ---------------------------------------------------

    private:
        /**
        * The class name.
        */
        const String::View m_vsName;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_CLASS_HPP

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