DOMError.hpp Source File

| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# DOMError.hpp

Go to the documentation of this 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.9  2003/05/14 18:06:53  gareth
    00063  * Updated DOMError to http://www.w3.org/TR/2003/WD-DOM-Level-3-Core-20030226/core.html.
    00064  *
    00065  * Revision 1.8  2003/03/07 19:59:04  tng
    00066  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
    00067  *
    00068  * Revision 1.7  2002/11/04 15:09:24  tng
    00069  * C++ Namespace Support.
    00070  *
    00071  * Revision 1.6  2002/08/22 15:04:57  tng
    00072  * Remove unused parameter variables in inline functions.
    00073  *
    00074  * Revision 1.5  2002/07/15 19:25:25  tng
    00075  * DOM L3:  declare a dummy DOMError::set/getRelatedException
    00076  *
    00077  * Revision 1.4  2002/06/06 21:01:21  tng
    00078  * [Bug 9639] enum_mem in DOMError clashes with constant.
    00079  *
    00080  * Revision 1.3  2002/06/06 20:53:06  tng
    00081  * Documentation Fix: Update the API Documentation for DOM headers
    00082  *
    00083  * Revision 1.2  2002/05/30 19:24:48  knoaman
    00084  * documentation update
    00085  *
    00086  * Revision 1.1  2002/05/23 15:47:24  knoaman
    00087  * DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
    00088  *
    00089  */
    00090
    00091
    00092 #include <xercesc/util/XercesDefs.hpp>
    00093
    00094 XERCES_CPP_NAMESPACE_BEGIN
    00095
    00096 class DOMLocator;
    00097
    00098
    00106 class  DOMError
    00107 {
    00108 protected:
    00109     // -----------------------------------------------------------------------
    00110     //  Hidden constructors
    00111     // -----------------------------------------------------------------------
    00114     DOMError() {};
    00116
    00117 private:
    00118     // -----------------------------------------------------------------------
    00119     // Unimplemented constructors and operators
    00120     // -----------------------------------------------------------------------
    00123     DOMError(const DOMError &);
    00124     DOMError & operator = (const DOMError &);
    00126
    00127 public:
    00128     // -----------------------------------------------------------------------
    00129     //  All constructors are hidden, just the destructor is available
    00130     // -----------------------------------------------------------------------
    00137     virtual ~DOMError() {};
    00139
    00140     // -----------------------------------------------------------------------
    00141     //  Class types
    00142     // -----------------------------------------------------------------------
    00150     enum ErrorSeverity
    00151     {
    00152         DOM_SEVERITY_WARNING     = 0,
    00153         DOM_SEVERITY_ERROR       = 1,
    00154         DOM_SEVERITY_FATAL_ERROR = 2
    00155     };
    00157
    00158
    00159     // -----------------------------------------------------------------------
    00160     //  Virtual DOMError interface
    00161     // -----------------------------------------------------------------------
    00164     // -----------------------------------------------------------------------
    00165     //  Getter methods
    00166     // -----------------------------------------------------------------------
    00175     virtual short getSeverity() const = 0;
    00176
    00185     virtual const XMLCh* getMessage() const = 0;
    00186
    00195     virtual DOMLocator* getLocation() const = 0;
    00196
    00205     virtual void* getRelatedException() const = 0;
    00206
    00224     virtual const XMLCh* getType() const = 0;
    00225
    00234     virtual void* getRelatedData() const = 0;
    00235
    00236
    00237     // -----------------------------------------------------------------------
    00238     //  Setter methods
    00239     // -----------------------------------------------------------------------
    00249     virtual void setSeverity(const short severity) = 0;
    00250
    00260     virtual void setMessage(const XMLCh* const message) = 0;
    00261
    00271     virtual void setLocation(DOMLocator* const location) = 0;
    00272
    00282     virtual void setRelatedException(void* exception) const = 0;
    00283
    00301     virtual void setType(const XMLCh* type) = 0;
    00302
    00311     virtual void setRelatedData(void* relatedData) = 0;
    00312
    00314
    00315 };
    00316
    00317 XERCES_CPP_NAMESPACE_END
    00318
    00319 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.