/* * Copyright 1999-2000,2004 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* * $Log: SAXParseException.hpp,v $ * Revision 1.7 2004/09/08 13:56:19 peiyongz * Apache License Version 2.0 * * Revision 1.6 2003/12/01 23:23:26 neilg * fix for bug 25118; thanks to Jeroen Witmond * * Revision 1.5 2003/08/13 15:43:24 knoaman * Use memory manager when creating SAX exceptions. * * Revision 1.4 2003/05/15 18:27:05 knoaman * Partial implementation of the configurable memory manager. * * 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. * @param manager Pointer to the memory manager to be used to * allocate objects. * @see Locator#Locator * @see Parser#setLocale */ SAXParseException(const XMLCh* const message, const Locator& locator, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); /** * 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. * @param manager Pointer to the memory manager to be used to * allocate objects. * @see Parser#setLocale */ SAXParseException ( const XMLCh* const message , const XMLCh* const publicId , const XMLCh* const systemId , const XMLSSize_t lineNumber , const XMLSSize_t columnNumber , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager ); /** * 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