DOMError.hpp Source File

00001 #ifndef DOMError_HEADER_GUARD_
00002 #define DOMError_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2002 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 1999, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Log: DOMError.hpp,v $
00062  * Revision 1.11  2003/12/01 23:23:25  neilg
00063  * fix for bug 25118; thanks to Jeroen Witmond
00064  *
00065  * Revision 1.10  2003/05/30 16:11:43  gareth
00066  * Fixes so we compile under VC7.1. Patch by Alberto Massari.
00067  *
00068  * Revision 1.9  2003/05/14 18:06:53  gareth
00069  * Updated DOMError to http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/core.html.
00070  *
00071  * Revision 1.8  2003/03/07 19:59:04  tng
00072  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
00073  *
00074  * Revision 1.7  2002/11/04 15:09:24  tng
00075  * C++ Namespace Support.
00076  *
00077  * Revision 1.6  2002/08/22 15:04:57  tng
00078  * Remove unused parameter variables in inline functions.
00079  *
00080  * Revision 1.5  2002/07/15 19:25:25  tng
00081  * DOM L3:  declare a dummy DOMError::set/getRelatedException
00082  *
00083  * Revision 1.4  2002/06/06 21:01:21  tng
00084  * [Bug 9639] enum_mem in DOMError clashes with constant.
00085  *
00086  * Revision 1.3  2002/06/06 20:53:06  tng
00087  * Documentation Fix: Update the API Documentation for DOM headers
00088  *
00089  * Revision 1.2  2002/05/30 19:24:48  knoaman
00090  * documentation update
00091  *
00092  * Revision 1.1  2002/05/23 15:47:24  knoaman
00093  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
00094  *
00095  */
00096 
00097 
00098 #include <xercesc/util/XercesDefs.hpp>
00099 
00100 XERCES_CPP_NAMESPACE_BEGIN
00101 
00102 class DOMLocator;
00103 
00104 
00112 class  DOMError
00113 {
00114 protected:
00115     // -----------------------------------------------------------------------
00116     //  Hidden constructors
00117     // -----------------------------------------------------------------------
00120     DOMError() {};
00122 
00123 private:
00124     // -----------------------------------------------------------------------
00125     // Unimplemented constructors and operators
00126     // -----------------------------------------------------------------------
00129     DOMError(const DOMError &);
00130     DOMError & operator = (const DOMError &);
00132 
00133 public:
00134     // -----------------------------------------------------------------------
00135     //  All constructors are hidden, just the destructor is available
00136     // -----------------------------------------------------------------------
00143     virtual ~DOMError() {};
00145 
00146     // -----------------------------------------------------------------------
00147     //  Class types
00148     // -----------------------------------------------------------------------
00156     enum ErrorSeverity
00157     {
00158         DOM_SEVERITY_WARNING     = 0,
00159         DOM_SEVERITY_ERROR       = 1,
00160         DOM_SEVERITY_FATAL_ERROR = 2
00161     };
00163 
00164 
00165     // -----------------------------------------------------------------------
00166     //  Virtual DOMError interface
00167     // -----------------------------------------------------------------------
00170     // -----------------------------------------------------------------------
00171     //  Getter methods
00172     // -----------------------------------------------------------------------
00181     virtual short getSeverity() const = 0;
00182 
00191     virtual const XMLCh* getMessage() const = 0;
00192 
00201     virtual DOMLocator* getLocation() const = 0;
00202 
00211     virtual void* getRelatedException() const = 0;
00212 
00230     virtual const XMLCh* getType() const = 0;
00231 
00240     virtual void* getRelatedData() const = 0;
00241 
00242 
00243     // -----------------------------------------------------------------------
00244     //  Setter methods
00245     // -----------------------------------------------------------------------
00255     virtual void setSeverity(const short severity) = 0;
00256 
00266     virtual void setMessage(const XMLCh* const message) = 0;
00267 
00277     virtual void setLocation(DOMLocator* const location) = 0;
00278 
00288     virtual void setRelatedException(void* exc) const = 0;
00289 
00307     virtual void setType(const XMLCh* type) = 0;
00308 
00317     virtual void setRelatedData(void* relatedData) = 0;
00318 
00320 
00321 };
00322 
00323 XERCES_CPP_NAMESPACE_END
00324 
00325 #endif