http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

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.2  2002/02/20 18:17:01  tng
00060   * [Bug 5977] Warnings on generating apiDocs.
00061   *
00062   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00063   * sane_include
00064   *
00065   * Revision 1.11  2001/05/11 13:25:32  tng
00066   * Copyright update.
00067   *
00068   * Revision 1.10  2001/05/03 19:08:56  knoaman
00069   * Support Warning/Error/FatalError messaging.
00070   * Validity constraints errors are treated as errors, with the ability by user to set
00071   * validity constraints as fatal errors.
00072   *
00073   * Revision 1.9  2000/12/14 18:49:57  tng
00074   * Fix API document generation warning: "Warning: end of member group without matching begin"
00075   *
00076   * Revision 1.8  2000/03/02 19:54:25  roddey
00077   * This checkin includes many changes done while waiting for the
00078   * 1.1.0 code to be finished. I can't list them all here, but a list is
00079   * available elsewhere.
00080   *
00081   * Revision 1.7  2000/02/24 20:00:23  abagchi
00082   * Swat for removing Log from API docs
00083   *
00084   * Revision 1.6  2000/02/16 23:03:48  roddey
00085   * More documentation updates
00086   *
00087   * Revision 1.5  2000/02/16 21:42:58  aruna1
00088   * API Doc++ summary changes in
00089   *
00090   * Revision 1.4  2000/02/15 23:59:07  roddey
00091   * More updated documentation of Framework classes.
00092   *
00093   * Revision 1.3  2000/02/15 01:21:31  roddey
00094   * Some initial documentation improvements. More to come...
00095   *
00096   * Revision 1.2  2000/02/06 07:47:48  rahulj
00097   * Year 2K copyright swat.
00098   *
00099   * Revision 1.1.1.1  1999/11/09 01:08:34  twl
00100   * Initial checkin
00101   *
00102   * Revision 1.2  1999/11/08 20:44:39  rahul
00103   * Swat for adding in Product name and CVS comment log variable.
00104   *
00105   */
00106 
00107 
00108 #if !defined(XMLERRORREPORTER_HPP)
00109 #define XMLERRORREPORTER_HPP
00110 
00111 #include <xercesc/util/XercesDefs.hpp>
00112 #include <xercesc/util/XMLMsgLoader.hpp>
00113 
00114 
00127 class  XMLErrorReporter
00128 {
00129 public:
00130     // -----------------------------------------------------------------------
00131     //  The types of errors we can issue
00132     // -----------------------------------------------------------------------
00133     enum ErrTypes
00134     {
00135         ErrType_Warning
00136         , ErrType_Error
00137         , ErrType_Fatal
00138 
00139         , ErrTypes_Unknown
00140     };
00141 
00142 
00143     // -----------------------------------------------------------------------
00144     //  Constructors are hidden, only the virtual destructor is exposed
00145     // -----------------------------------------------------------------------
00146 
00149 
00153     virtual ~XMLErrorReporter()
00154     {
00155     }
00157 
00158 
00159     // -----------------------------------------------------------------------
00160     //  The error handler interface
00161     // -----------------------------------------------------------------------
00162 
00165 
00201     virtual void error
00202     (
00203         const   unsigned int        errCode
00204         , const XMLCh* const        errDomain
00205         , const ErrTypes            type
00206         , const XMLCh* const        errorText
00207         , const XMLCh* const        systemId
00208         , const XMLCh* const        publicId
00209         , const unsigned int        lineNum
00210         , const unsigned int        colNum
00211     ) = 0;
00212 
00219     virtual void resetErrors() = 0;
00220 
00222 
00223 
00224 protected :
00225 
00228 
00232     XMLErrorReporter()
00233     {
00234     }
00236 
00237 private:
00238     // -----------------------------------------------------------------------
00239     //  Unimplemented constructors and destructor
00240     // -----------------------------------------------------------------------
00241     XMLErrorReporter(const XMLErrorReporter&);
00242     void operator=(const XMLErrorReporter&);
00243 };
00244 
00245 #endif


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