coherence/io/pof/PortableException.hpp

/*
* PortableException.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_PORTABLE_EXCEPTION_HPP
#define COH_PORTABLE_EXCEPTION_HPP

#include "coherence/lang.ns"

#include "coherence/io/pof/PofReader.hpp"
#include "coherence/io/pof/PofWriter.hpp"
#include "coherence/io/pof/PortableObject.hpp"

COH_OPEN_NAMESPACE3(coherence,io,pof)


/**
* A PortableException is an exception that allows information about a remote
* exception or error to be serialized and deserialized to/from a POF stream.
*
* @author jh,mf  2008.01.23
*/
class COH_EXPORT PortableException
    : public throwable_spec<PortableException,
        extends<RuntimeException>,
        implements<PortableObject> >
    {
    friend class factory<PortableException>;

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

    protected:
        /**
        * Construct a PortableException from a Throwable object and an
        * additional description.
        *
        * @param vsMessage  the additional description
        * @param ve         the cause exception
        */
        PortableException(String::View vsMessage = String::NULL_STRING,
                Exception::View ve = NULL);

        /**
        * {{@inheritDoc}}
        */
        virtual void onInit();

    // ----- PortableObject interface ---------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void readExternal(PofReader::Handle hIn);

        /**
        * {@inheritDoc}
        */
        virtual void writeExternal(PofWriter::Handle hOut) const;


    // ----- Exception interface --------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual String::View getName() const;

        /**
        * {@inheritDoc}
        */
        virtual ObjectArray::View getStackTrace() const;


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

    protected:
        /**
        * The exception's name.
        */
        MemberView<String> m_vsName;

        /**
        * A raw representaion of the remote stack trace for this exception.
        */
        MemberView<ObjectArray> m_vaStackRemote;
    };

COH_CLOSE_NAMESPACE3

#endif // COH_PORTABLE_EXCEPTION_HPP

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