XMLErrorReporter.hpp Source File

| API Docs for SAX and DOM |

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

# XMLErrorReporter.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
    00005  * reserved.
    00006  *
    00007  * Redistribution and use in source and binary forms, with or without
    00008  * modification, are permitted provided that the following conditions
    00009  * are met:
    00010  *
    00011  * 1. Redistributions of source code must retain the above copyright
    00012  *    notice, this list of conditions and the following disclaimer.
    00013  *
    00014  * 2. Redistributions in binary form must reproduce the above copyright
    00015  *    notice, this list of conditions and the following disclaimer in
    00016  *    the documentation and/or other materials provided with the
    00017  *    distribution.
    00018  *
    00019  * 3. The end-user documentation included with the redistribution,
    00020  *    if any, must include the following acknowledgment:
    00021  *       "This product includes software developed by the
    00022  *        Apache Software Foundation (http://www.apache.org/)."
    00023  *    Alternately, this acknowledgment may appear in the software itself,
    00024  *    if and wherever such third-party acknowledgments normally appear.
    00025  *
    00026  * 4. The names "Xerces" and "Apache Software Foundation" must
    00027  *    not be used to endorse or promote products derived from this
    00028  *    software without prior written permission. For written
    00029  *    permission, please contact apache\@apache.org.
    00030  *
    00031  * 5. Products derived from this software may not be called "Apache",
    00032  *    nor may "Apache" appear in their name, without prior written
    00033  *    permission of the Apache Software Foundation.
    00034  *
    00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00046  * SUCH DAMAGE.
    00047  * ====================================================================
    00048  *
    00049  * This software consists of voluntary contributions made by many
    00050  * individuals on behalf of the Apache Software Foundation, and was
    00051  * originally based on software copyright (c) 1999, International
    00052  * Business Machines, Inc., http://www.ibm.com .  For more information
    00053  * on the Apache Software Foundation, please see
    00054  * <http://www.apache.org/>.
    00055  */
    00056
    00057  /*
    00058   * $Log: XMLErrorReporter.hpp,v $
    00059   * Revision 1.6  2003/03/07 18:08:10  tng
    00060   * Return a reference instead of void for operator=
    00061   *
    00062   * Revision 1.5  2002/12/04 02:32:43  knoaman
    00063   * #include cleanup.
    00064   *
    00065   * Revision 1.4  2002/11/04 15:00:21  tng
    00066   * C++ Namespace Support.
    00067   *
    00068   * Revision 1.3  2002/05/27 18:34:59  tng
    00069   * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
    00070   *
    00071   * Revision 1.2  2002/02/20 18:17:01  tng
    00072   * [Bug 5977] Warnings on generating apiDocs.
    00073   *
    00074   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
    00075   * sane_include
    00076   *
    00077   * Revision 1.11  2001/05/11 13:25:32  tng
    00078   * Copyright update.
    00079   *
    00080   * Revision 1.10  2001/05/03 19:08:56  knoaman
    00081   * Support Warning/Error/FatalError messaging.
    00082   * Validity constraints errors are treated as errors, with the ability by user to set
    00083   * validity constraints as fatal errors.
    00084   *
    00085   * Revision 1.9  2000/12/14 18:49:57  tng
    00086   * Fix API document generation warning: "Warning: end of member group without matching begin"
    00087   *
    00088   * Revision 1.8  2000/03/02 19:54:25  roddey
    00089   * This checkin includes many changes done while waiting for the
    00090   * 1.1.0 code to be finished. I can't list them all here, but a list is
    00091   * available elsewhere.
    00092   *
    00093   * Revision 1.7  2000/02/24 20:00:23  abagchi
    00094   * Swat for removing Log from API docs
    00095   *
    00096   * Revision 1.6  2000/02/16 23:03:48  roddey
    00097   * More documentation updates
    00098   *
    00099   * Revision 1.5  2000/02/16 21:42:58  aruna1
    00100   * API Doc++ summary changes in
    00101   *
    00102   * Revision 1.4  2000/02/15 23:59:07  roddey
    00103   * More updated documentation of Framework classes.
    00104   *
    00105   * Revision 1.3  2000/02/15 01:21:31  roddey
    00106   * Some initial documentation improvements. More to come...
    00107   *
    00108   * Revision 1.2  2000/02/06 07:47:48  rahulj
    00109   * Year 2K copyright swat.
    00110   *
    00111   * Revision 1.1.1.1  1999/11/09 01:08:34  twl
    00112   * Initial checkin
    00113   *
    00114   * Revision 1.2  1999/11/08 20:44:39  rahul
    00115   * Swat for adding in Product name and CVS comment log variable.
    00116   *
    00117   */
    00118
    00119
    00120 #if !defined(XMLERRORREPORTER_HPP)
    00121 #define XMLERRORREPORTER_HPP
    00122
    00123 #include <xercesc/util/XercesDefs.hpp>
    00124
    00125 XERCES_CPP_NAMESPACE_BEGIN
    00126
    00127
    00140 class  XMLErrorReporter
    00141 {
    00142 public:
    00143     // -----------------------------------------------------------------------
    00144     //  The types of errors we can issue
    00145     // -----------------------------------------------------------------------
    00146     enum ErrTypes
    00147     {
    00148         ErrType_Warning
    00149         , ErrType_Error
    00150         , ErrType_Fatal
    00151
    00152         , ErrTypes_Unknown
    00153     };
    00154
    00155
    00156     // -----------------------------------------------------------------------
    00157     //  Constructors are hidden, only the virtual destructor is exposed
    00158     // -----------------------------------------------------------------------
    00159
    00162
    00166     virtual ~XMLErrorReporter()
    00167     {
    00168     }
    00170
    00171
    00172     // -----------------------------------------------------------------------
    00173     //  The error handler interface
    00174     // -----------------------------------------------------------------------
    00175
    00178
    00214     virtual void error
    00215     (
    00216         const   unsigned int        errCode
    00217         , const XMLCh* const        errDomain
    00218         , const ErrTypes            type
    00219         , const XMLCh* const        errorText
    00220         , const XMLCh* const        systemId
    00221         , const XMLCh* const        publicId
    00222         , const XMLSSize_t          lineNum
    00223         , const XMLSSize_t          colNum
    00224     ) = 0;
    00225
    00232     virtual void resetErrors() = 0;
    00233
    00235
    00236
    00237 protected :
    00238
    00241
    00245     XMLErrorReporter()
    00246     {
    00247     }
    00249
    00250 private:
    00251     // -----------------------------------------------------------------------
    00252     //  Unimplemented constructors and destructor
    00253     // -----------------------------------------------------------------------
    00254     XMLErrorReporter(const XMLErrorReporter&);
    00255     XMLErrorReporter& operator=(const XMLErrorReporter&);
    00256 };
    00257
    00258 XERCES_CPP_NAMESPACE_END
    00259
    00260 #endif

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