/* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2000 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * . */ /* * $Log: SAXParseException.hpp,v $ * Revision 1.3 2002/11/04 14:56:26 tng * C++ Namespace Support. * * Revision 1.2 2002/05/27 18:33:07 tng * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number. * * Revision 1.1.1.1 2002/02/01 22:22:08 peiyongz * sane_include * * Revision 1.5 2000/02/24 20:12:55 abagchi * Swat for removing Log from API docs * * Revision 1.4 2000/02/12 01:27:19 aruna1 * Documentation updated * * Revision 1.3 2000/02/09 19:24:49 abagchi * Inserted documentation for constructors and destructors * * Revision 1.2 2000/02/06 07:47:58 rahulj * Year 2K copyright swat. * * Revision 1.1.1.1 1999/11/09 01:07:47 twl * Initial checkin * * Revision 1.2 1999/11/08 20:45:02 rahul * Swat for adding in Product name and CVS comment log variable. * */ #ifndef SAXPARSEEXCEPTION_HPP #define SAXPARSEEXCEPTION_HPP #include XERCES_CPP_NAMESPACE_BEGIN class Locator; /** * Encapsulate an XML parse error or warning. * *

This exception will include information for locating the error * in the original XML document. Note that although the application * will receive a SAXParseException as the argument to the handlers * in the ErrorHandler interface, the application is not actually * required to throw the exception; instead, it can simply read the * information in it and take a different action.

* *

Since this exception is a subclass of SAXException, it * inherits the ability to wrap another exception.

* * @see SAXException#SAXException * @see Locator#Locator * @see ErrorHandler#ErrorHandler */ class SAX_EXPORT SAXParseException : public SAXException { public: /** @name Constructors and Destructor */ //@{ /** * Create a new SAXParseException from a message and a Locator. * *

This constructor is especially useful when an application is * creating its own exception from within a DocumentHandler * callback.

* * @param message The error or warning message. * @param locator The locator object for the error or warning. * @see Locator#Locator * @see Parser#setLocale */ SAXParseException(const XMLCh* const message, const Locator& locator); /** * Create a new SAXParseException. * *

This constructor is most useful for parser writers.

* *

If the system identifier is a URL, the parser must resolve it * fully before creating the exception.

* * @param message The error or warning message. * @param publicId The public identifer of the entity that generated * the error or warning. * @param systemId The system identifer of the entity that generated * the error or warning. * @param lineNumber The line number of the end of the text that * caused the error or warning. * @param columnNumber The column number of the end of the text that * caused the error or warning. * @see Parser#setLocale */ SAXParseException ( const XMLCh* const message , const XMLCh* const publicId , const XMLCh* const systemId , const XMLSSize_t lineNumber , const XMLSSize_t columnNumber ); /** * Copy constructor * * @param toCopy The object to be copied */ SAXParseException(const SAXParseException& toCopy); /** * Destructor */ ~SAXParseException(); //@} /** @name Assignment operator */ //@{ /** * Assignment operator * * @param toAssign The object to be copied through assignment * */ SAXParseException& operator=(const SAXParseException& toAssign); //@} /** @name Getter methods */ //@{ /** * The column number of the end of the text where the exception occurred. * *

The first column in a line is position 1.

* * @return An integer representing the column number, or -1 * if none is available. * @see Locator#getColumnNumber */ XMLSSize_t getColumnNumber() const; /** * The line number of the end of the text where the exception occurred. * * @return An integer representing the line number, or -1 * if none is available. * @see Locator#getLineNumber */ XMLSSize_t getLineNumber() const; /** * Get the public identifier of the entity where the exception occurred. * * @return A string containing the public identifier, or null * if none is available. * @see Locator#getPublicId */ const XMLCh* getPublicId() const; /** * Get the system identifier of the entity where the exception occurred. * *

If the system identifier is a URL, it will be resolved * fully.

* * @return A string containing the system identifier, or null * if none is available. * @see Locator#getSystemId */ const XMLCh* getSystemId() const; //@} private: /* Data Members */ /* The column in the source text where the error occured. */ XMLSSize_t fColumnNumber; /* The line in the source text where the error occured. */ XMLSSize_t fLineNumber; /* The public id of the file where the error occured. */ XMLCh* fPublicId; /* The system id of the file where the error occured. */ XMLCh* fSystemId; }; XERCES_CPP_NAMESPACE_END #endif