jaula API Reference version 1.4.0
|
Base class for error handling exceptions. More...
#include <jaula_exception.h>
Public Types | |
enum | ExCode { NO_ERROR , BAD_DATA_TYPE , NAME_DUPLICATED , LEXAN_ERROR , SYNTAX_ERROR } |
Enumeration of available error codes. More... | |
Public Member Functions | |
void | addOrigin (std::string const &origin) |
Attachs a new origin after the existing ones. | |
void | display (std::ostream &ostr) const |
Represents the instance in a stream. | |
Exception (Exception const &orig) | |
Copy constructor. | |
Exception (ExCode code=NO_ERROR, std::string const &detail="", std::string const &action="", std::string const &origin="") | |
Constructor. | |
std::string const & | getAction (void) const |
Retrieves the action that caused the exception. | |
ExCode | getCode (void) const |
Retrieves the error code for the exception. | |
virtual std::string const & | getDetail (void) const |
Retrieves the detailed description for the exception. | |
std::string const & | getOrigin (void) const |
Retrieves the method being run when the exception arose. | |
Exception & | operator= (Exception const &orig) |
Assignment operator. | |
void | setAction (std::string const &action) |
Establishes the action that caused the exception. | |
void | setDetail (std::string const &detail) |
Establishes the description for the exception. | |
void | setOrigin (std::string const &origin) |
Establishes the method being run when the exception arose. | |
virtual | ~Exception () |
Destructor. | |
Protected Member Functions | |
void | setCode (ExCode code) |
Establishes the error code for the exception. | |
Private Attributes | |
std::string | action_ |
Container action causing the exception. | |
ExCode | code_ |
Container for error code. | |
std::string | detail_ |
Container for exception textual detail. | |
std::string | origin_ |
Container for where the exception was detected. | |
Base class for error handling exceptions.
JAULA::Exception::Exception | ( | ExCode | code = NO_ERROR , |
std::string const & | detail = "" , |
||
std::string const & | action = "" , |
||
std::string const & | origin = "" |
||
) |
Constructor.
code | Code for the exception as defined in ExCode |
detail | detailed description about the exception which made execution fail. |
action | action being performed when the exception arose. |
origin | Name of the method (and others methods that have called this) by the time the exception arose. |
JAULA::Exception::Exception | ( | Exception const & | orig | ) |
Copy constructor.
orig | Original instance to copy |
|
virtual |
Destructor.
void JAULA::Exception::addOrigin | ( | std::string const & | origin | ) |
Attachs a new origin after the existing ones.
origin | Name of the method to add |
References origin_.
Referenced by JAULA::Value::duplicate(), JAULA::Parser::Value_Parser::EOFError(), JAULA::Value::operator=(), JAULA::Parser::parseStream(), JAULA::Parser::Value_Parser::parseValue(), JAULA::Value_Array::set(), JAULA::Value_Boolean::set(), JAULA::Value_Null::set(), JAULA::Value_Number::set(), JAULA::Value_Number_Int::set(), JAULA::Value_Object::set(), and JAULA::Value_String::set().
void JAULA::Exception::display | ( | std::ostream & | ostr | ) | const |
Represents the instance in a stream.
ostr | Stream where the instance is to be displayed. |
References action_, BAD_DATA_TYPE, code_, detail_, LEXAN_ERROR, NAME_DUPLICATED, NO_ERROR, and origin_.
Referenced by operator<<().
std::string const & JAULA::Exception::getAction | ( | void | ) | const |
Exception::ExCode JAULA::Exception::getCode | ( | void | ) | const |
|
virtual |
Retrieves the detailed description for the exception.
Reimplemented in JAULA::Name_Duplicated.
References detail_.
Referenced by operator=().
std::string const & JAULA::Exception::getOrigin | ( | void | ) | const |
Retrieves the method being run when the exception arose.
References origin_.
Referenced by operator=().
Assignment operator.
orig | Original instance to copy |
References action_, code_, detail_, getAction(), getCode(), getDetail(), getOrigin(), and origin_.
Referenced by JAULA::Bad_Data_Type::operator=(), JAULA::Lexan_Error::operator=(), JAULA::Name_Duplicated::operator=(), JAULA::No_Error::operator=(), and JAULA::Syntax_Error::operator=().
void JAULA::Exception::setAction | ( | std::string const & | action | ) |
Establishes the action that caused the exception.
action | action being performed when the exception arose. |
References action_.
|
protected |
Establishes the error code for the exception.
code | Code for the exception as defined in ExCode |
References code_.
void JAULA::Exception::setDetail | ( | std::string const & | detail | ) |
Establishes the description for the exception.
detail | detailed description about the exception which made execution fail. |
References detail_.
void JAULA::Exception::setOrigin | ( | std::string const & | origin | ) |
Establishes the method being run when the exception arose.
origin | Name of the method (and others methods that have called this) by the time the exception arose. |
References origin_.
|
private |
Container action causing the exception.
Referenced by display(), getAction(), operator=(), and setAction().
|
private |
Container for error code.
Referenced by display(), getCode(), operator=(), and setCode().
|
private |
Container for exception textual detail.
Referenced by display(), getDetail(), operator=(), and setDetail().
|
private |
Container for where the exception was detected.
Referenced by addOrigin(), display(), getOrigin(), operator=(), and setOrigin().
Copyright (c) 2007, 2008, 2009 Kombo Morongo.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
jaula project hosted by