activemq::commands::BrokerError Class Reference
This class represents an Exception sent from the Broker. More...
#include <src/main/activemq/commands/BrokerError.h>
Data Structures | |
| struct | StackTraceElement |
Public Member Functions | |
| BrokerError () | |
| virtual | ~BrokerError () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual BrokerError * | cloneDataStructure () const |
| Clone this object and return a new instance that the caller now owns, this will be an exact copy of this one. | |
| virtual void | copyDataStructure (const DataStructure *src) |
| Copy the contents of the passed object into this objects members, overwriting any existing data. | |
| virtual decaf::lang::Pointer < commands::Command > | visit (activemq::state::CommandVisitor *visitor) |
| Allows a Visitor to visit this command and return a response to the command based on the command type being visited. | |
| virtual const std::string & | getMessage () const |
| Gets the string holding the error message. | |
| virtual void | setMessage (const std::string &message) |
| Sets the string that contains the error Message. | |
| virtual const std::string & | getExceptionClass () const |
| Gets the string holding the Exception Class name. | |
| virtual void | setExceptionClass (const std::string &exceptionClass) |
| Sets the string that contains the Exception Class name. | |
| virtual const decaf::lang::Pointer < BrokerError > & | getCause () const |
| Gets the Broker Error that caused this exception. | |
| virtual void | setCause (const decaf::lang::Pointer< BrokerError > &cause) |
| Sets the Broker Error that caused this exception. | |
| virtual const std::vector < decaf::lang::Pointer < StackTraceElement > > & | getStackTraceElements () const |
| Gets the Stack Trace Elements for the Exception. | |
| virtual void | setStackTraceElements (const std::vector< decaf::lang::Pointer< StackTraceElement > > &stackTraceElements) |
| Sets the Stack Trace Elements for this Exception. | |
Detailed Description
This class represents an Exception sent from the Broker.
The Broker sends java Throwables, so we must mimic its structure here.
Constructor & Destructor Documentation
| activemq::commands::BrokerError::BrokerError | ( | ) |
| virtual activemq::commands::BrokerError::~BrokerError | ( | ) | [virtual] |
Member Function Documentation
| virtual BrokerError* activemq::commands::BrokerError::cloneDataStructure | ( | ) | const [inline, virtual] |
Clone this object and return a new instance that the caller now owns, this will be an exact copy of this one.
- Returns:
- new copy of this object.
Implements activemq::commands::DataStructure.
References copyDataStructure().
| virtual void activemq::commands::BrokerError::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Copy the contents of the passed object into this objects members, overwriting any existing data.
- Returns:
- src - Source Object
Reimplemented from activemq::commands::BaseCommand.
Referenced by cloneDataStructure().
| virtual const decaf::lang::Pointer<BrokerError>& activemq::commands::BrokerError::getCause | ( | ) | const [inline, virtual] |
Gets the Broker Error that caused this exception.
- Returns:
- Broker Error Pointer
| virtual unsigned char activemq::commands::BrokerError::getDataStructureType | ( | ) | const [inline, virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Implements activemq::commands::DataStructure.
| virtual const std::string& activemq::commands::BrokerError::getExceptionClass | ( | ) | const [inline, virtual] |
Gets the string holding the Exception Class name.
- Returns:
- Exception Class name
| virtual const std::string& activemq::commands::BrokerError::getMessage | ( | ) | const [inline, virtual] |
Gets the string holding the error message.
- Returns:
- String Message
| virtual const std::vector< decaf::lang::Pointer<StackTraceElement> >& activemq::commands::BrokerError::getStackTraceElements | ( | ) | const [inline, virtual] |
Gets the Stack Trace Elements for the Exception.
- Returns:
- Stack Trace Elements
| virtual void activemq::commands::BrokerError::setCause | ( | const decaf::lang::Pointer< BrokerError > & | cause | ) | [inline, virtual] |
Sets the Broker Error that caused this exception.
- Parameters:
-
cause - Broker Error
| virtual void activemq::commands::BrokerError::setExceptionClass | ( | const std::string & | exceptionClass | ) | [inline, virtual] |
Sets the string that contains the Exception Class name.
- Parameters:
-
exceptionClass - String Exception Class name
| virtual void activemq::commands::BrokerError::setMessage | ( | const std::string & | message | ) | [inline, virtual] |
| virtual void activemq::commands::BrokerError::setStackTraceElements | ( | const std::vector< decaf::lang::Pointer< StackTraceElement > > & | stackTraceElements | ) | [inline, virtual] |
Sets the Stack Trace Elements for this Exception.
- Parameters:
-
stackTraceElements - Stack Trace Elements
| virtual decaf::lang::Pointer<commands::Command> activemq::commands::BrokerError::visit | ( | activemq::state::CommandVisitor * | visitor | ) | [virtual] |
Allows a Visitor to visit this command and return a response to the command based on the command type being visited.
The command will call the proper processXXX method in the visitor.
- Returns:
- a Response to the visitor being called or NULL if no response.
Implements activemq::commands::Command.
The documentation for this class was generated from the following file:
- src/main/activemq/commands/BrokerError.h
