SAXParseException.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 1999-2000 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: SAXParseException.hpp,v $
00059  * Revision 1.5  2000/02/24 20:12:55  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.4  2000/02/12 01:27:19  aruna1
00063  * Documentation updated
00064  *
00065  * Revision 1.3  2000/02/09 19:24:49  abagchi
00066  * Inserted documentation for constructors and destructors
00067  *
00068  * Revision 1.2  2000/02/06 07:47:58  rahulj
00069  * Year 2K copyright swat.
00070  *
00071  * Revision 1.1.1.1  1999/11/09 01:07:47  twl
00072  * Initial checkin
00073  *
00074  * Revision 1.2  1999/11/08 20:45:02  rahul
00075  * Swat for adding in Product name and CVS comment log variable.
00076  *
00077  */
00078 
00079 
00080 #ifndef SAXPARSEEXCEPTION_HPP
00081 #define SAXPARSEEXCEPTION_HPP
00082 
00083 #include    <sax/SAXException.hpp>
00084 
00085 class Locator;
00086 
00104 class  SAXParseException : public SAXException
00105 {
00106 public:
00109 
00121     SAXParseException(const XMLCh* const message, const Locator& locator);
00122 
00123 
00143     SAXParseException
00144     (
00145         const   XMLCh* const    message
00146         , const XMLCh* const    publicId
00147         , const XMLCh* const    systemId
00148         , const unsigned int    lineNumber
00149         , const unsigned int    columnNumber
00150     );
00151 
00157     SAXParseException(const SAXParseException& toCopy);
00158 
00162     ~SAXParseException();
00163 
00165 
00168 
00174     SAXParseException& operator=(const SAXParseException& toAssign);
00176 
00179 
00188     unsigned int getColumnNumber() const;
00196     unsigned int getLineNumber() const;
00204     const XMLCh* getPublicId() const;
00215     const XMLCh* getSystemId() const;
00217 
00218 private:
00219     /* Data Members */
00220     
00221     /* The column in the source text where the error occured. */
00222     unsigned int    fColumnNumber;
00223     /* The line in the source text where the error occured. */
00224     unsigned int    fLineNumber;
00225     /* The public id of the file where the error occured. */
00226     XMLCh*          fPublicId;
00227     /* The system id of the file where the error occured. */
00228     XMLCh*          fSystemId;
00229     
00230 
00231 };
00232 
00233 #endif