[80] | 1 | // |
---|
| 2 | // EventException.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/XML/include/Poco/DOM/EventException.h#1 $ |
---|
| 5 | // |
---|
| 6 | // Library: XML |
---|
| 7 | // Package: DOM |
---|
| 8 | // Module: DOMEvents |
---|
| 9 | // |
---|
| 10 | // Definition of the DOM EventException class. |
---|
| 11 | // |
---|
| 12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
| 13 | // and Contributors. |
---|
| 14 | // |
---|
| 15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
| 16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
| 17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
| 18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
| 19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
| 20 | // do so, all subject to the following: |
---|
| 21 | // |
---|
| 22 | // The copyright notices in the Software and this entire statement, including |
---|
| 23 | // the above license grant, this restriction and the following disclaimer, |
---|
| 24 | // must be included in all copies of the Software, in whole or in part, and |
---|
| 25 | // all derivative works of the Software, unless such copies or derivative |
---|
| 26 | // works are solely in the form of machine-executable object code generated by |
---|
| 27 | // a source language processor. |
---|
| 28 | // |
---|
| 29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
| 32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
| 33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
| 34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
| 35 | // DEALINGS IN THE SOFTWARE. |
---|
| 36 | // |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | #ifndef DOM_EventException_INCLUDED |
---|
| 40 | #define DOM_EventException_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/XML/XML.h" |
---|
| 44 | #include "Poco/XML/XMLException.h" |
---|
| 45 | |
---|
| 46 | |
---|
| 47 | namespace Poco { |
---|
| 48 | namespace XML { |
---|
| 49 | |
---|
| 50 | |
---|
| 51 | class XML_API EventException: public XMLException |
---|
| 52 | /// Event operations may throw an EventException as |
---|
| 53 | /// specified in their method descriptions. |
---|
| 54 | { |
---|
| 55 | public: |
---|
| 56 | enum |
---|
| 57 | { |
---|
| 58 | UNSPECIFIED_EVENT_TYPE_ERR = 0 /// If the Event's type was not specified by initializing the |
---|
| 59 | /// event before the method was called. Specification of the Event's |
---|
| 60 | /// type as null or an empty string will also trigger this exception. |
---|
| 61 | }; |
---|
| 62 | |
---|
| 63 | EventException(int code); |
---|
| 64 | /// Creates an EventException with the given error code. |
---|
| 65 | |
---|
| 66 | EventException(const EventException& exc); |
---|
| 67 | /// Creates an EventException by copying another one. |
---|
| 68 | |
---|
| 69 | ~EventException() throw(); |
---|
| 70 | /// Destroys the EventException. |
---|
| 71 | |
---|
| 72 | EventException& operator = (const EventException& exc); |
---|
| 73 | |
---|
| 74 | const char* name() const throw(); |
---|
| 75 | /// Returns a static string describing the exception. |
---|
| 76 | |
---|
| 77 | const char* className() const throw(); |
---|
| 78 | /// Returns the name of the exception class. |
---|
| 79 | |
---|
| 80 | unsigned short code() const; |
---|
| 81 | /// Returns the Event exception code. |
---|
| 82 | |
---|
| 83 | protected: |
---|
| 84 | Poco::Exception* clone() const; |
---|
| 85 | |
---|
| 86 | private: |
---|
| 87 | EventException(); |
---|
| 88 | }; |
---|
| 89 | |
---|
| 90 | |
---|
| 91 | // |
---|
| 92 | // inlines |
---|
| 93 | // |
---|
| 94 | inline unsigned short EventException::code() const |
---|
| 95 | { |
---|
| 96 | return UNSPECIFIED_EVENT_TYPE_ERR; |
---|
| 97 | } |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | } } // namespace Poco::XML |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | #endif // DOM_EventException_INCLUDED |
---|