| #ifndef DOMError_HEADER_GUARD_ |
| #define DOMError_HEADER_GUARD_ |
| |
| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache\@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation, and was |
| * originally based on software copyright (c) 1999, International |
| * Business Machines, Inc., http://www.ibm.com . For more information |
| * on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| /* |
| * $Log$ |
| * Revision 1.6 2002/08/22 15:04:57 tng |
| * Remove unused parameter variables in inline functions. |
| * |
| * Revision 1.5 2002/07/15 19:25:25 tng |
| * DOM L3: declare a dummy DOMError::set/getRelatedException |
| * |
| * Revision 1.4 2002/06/06 21:01:21 tng |
| * [Bug 9639] enum_mem in DOMError clashes with constant. |
| * |
| * Revision 1.3 2002/06/06 20:53:06 tng |
| * Documentation Fix: Update the API Documentation for DOM headers |
| * |
| * Revision 1.2 2002/05/30 19:24:48 knoaman |
| * documentation update |
| * |
| * Revision 1.1 2002/05/23 15:47:24 knoaman |
| * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator |
| * |
| */ |
| |
| |
| #include <xercesc/util/XercesDefs.hpp> |
| |
| class DOMLocator; |
| |
| |
| /** |
| * DOMError is an interface that describes an error. |
| * |
| * @see DOMErrorHandler#handleError |
| * @since DOM Level 3 |
| */ |
| |
| class CDOM_EXPORT DOMError |
| { |
| protected: |
| // ----------------------------------------------------------------------- |
| // Hidden constructors |
| // ----------------------------------------------------------------------- |
| /** @name Hidden constructors */ |
| //@{ |
| DOMError() {}; |
| DOMError(const DOMError &) {}; |
| DOMError & operator = (const DOMError &) {return *this;}; |
| //@} |
| |
| public: |
| // ----------------------------------------------------------------------- |
| // All constructors are hidden, just the destructor is available |
| // ----------------------------------------------------------------------- |
| /** @name Destructor */ |
| //@{ |
| /** |
| * Destructor |
| * |
| */ |
| virtual ~DOMError() {}; |
| //@} |
| |
| // ----------------------------------------------------------------------- |
| // Class types |
| // ----------------------------------------------------------------------- |
| /** @name Public constants */ |
| //@{ |
| /** |
| * The severity of the error described by the <code>DOMError</code>. |
| * |
| * @since DOM Level 3 |
| */ |
| enum ErrorSeverity |
| { |
| DOM_SEVERITY_WARNING = 0, |
| DOM_SEVERITY_ERROR = 1, |
| DOM_SEVERITY_FATAL_ERROR = 2 |
| }; |
| //@} |
| |
| |
| // ----------------------------------------------------------------------- |
| // Virtual DOMError interface |
| // ----------------------------------------------------------------------- |
| /** @name Functions introduced in DOM Level 3 */ |
| //@{ |
| // ----------------------------------------------------------------------- |
| // Getter methods |
| // ----------------------------------------------------------------------- |
| /** |
| * Get the severity of the error |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @see setSeverity |
| * @since DOM Level 3 |
| */ |
| virtual short getSeverity() const = 0; |
| |
| /** |
| * Get the message describing the error that occured. |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @see setMessage |
| * @since DOM Level 3 |
| */ |
| virtual const XMLCh* getMessage() const = 0; |
| |
| /** |
| * Get the location of the error |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @see setLocation |
| * @since DOM Level 3 |
| */ |
| virtual DOMLocator* getLocation() const = 0; |
| |
| /** |
| * The related platform dependent exception if any. |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @see setRelatedException |
| * @since DOM Level 3 |
| */ |
| virtual void* getRelatedException() const = 0; |
| |
| // ----------------------------------------------------------------------- |
| // Setter methods |
| // ----------------------------------------------------------------------- |
| /** |
| * Set the severity of the error |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @param severity the type of the error to set |
| * @see getLocation |
| * @since DOM Level 3 |
| */ |
| virtual void setSeverity(const short severity) = 0; |
| |
| /** |
| * Set the error message |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @param message the error message to set. |
| * @see getMessage |
| * @since DOM Level 3 |
| */ |
| virtual void setMessage(const XMLCh* const message) = 0; |
| |
| /** |
| * Set the location of the error |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @param location the location of the error to set. |
| * @see getLocation |
| * @since DOM Level 3 |
| */ |
| virtual void setLocation(DOMLocator* const location) = 0; |
| |
| /** |
| * The related platform dependent exception if any. |
| * |
| * <p><b>"Experimental - subject to change"</b></p> |
| * |
| * @param exception the related exception to set. |
| * @see getRelatedException |
| * @since DOM Level 3 |
| */ |
| virtual void setRelatedException(void* exception) const = 0; |
| |
| //@} |
| |
| }; |
| |
| #endif |