CMSException.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _CMS_CMSEXCEPTION_H_
#define _CMS_CMSEXCEPTION_H_

// Includes
#include <string>
#include <vector>
#include <iostream>
#include <exception>

#include <cms/Config.h>

namespace cms {

    class CMSExceptionData;

    class CMS_API CMSException : public std::exception {
    private:

        // The actual data that defines this exception.
        CMSExceptionData* data;

    public:

        CMSException();

        CMSException(const CMSException& ex);

        CMSException(const std::string& message);

        CMSException(const std::string& message, const std::exception* cause);

        CMSException(const std::string& message, const std::exception* cause,
                     const std::vector<std::pair<std::string, int> >& stackTrace);

        virtual ~CMSException() throw();

        virtual std::string getMessage() const;

        virtual const std::exception* getCause() const;

        virtual std::vector< std::pair< std::string, int> > getStackTrace() const;

        virtual void setMark(const char* file, const int lineNumber);

        virtual void printStackTrace() const;

        virtual void printStackTrace(std::ostream& stream) const;

        virtual std::string getStackTraceString() const;

        virtual const char* what() const throw();

        virtual CMSException* clone();

    private:

        CMSException& operator=(const cms::CMSException&) {
            return *this;
        }

    };

}

#endif /*_CMS_CMSEXCEPTION_H_*/