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: EndOfEntityException.hpp,v $ 00059 * Revision 1.1 2002/05/11 20:17:57 bhavani 00060 * CR#CR062582# adding xercesc 1.7 file 00061 * 00062 * Revision 1.1.1.1 2002/02/01 22:21:58 peiyongz 00063 * sane_include 00064 * 00065 * Revision 1.3 2000/02/24 20:18:07 abagchi 00066 * Swat for removing Log from API docs 00067 * 00068 * Revision 1.2 2000/02/06 07:47:53 rahulj 00069 * Year 2K copyright swat. 00070 * 00071 * Revision 1.1.1.1 1999/11/09 01:08:07 twl 00072 * Initial checkin 00073 * 00074 * Revision 1.2 1999/11/08 20:44:42 rahul 00075 * Swat for adding in Product name and CVS comment log variable. 00076 * 00077 */ 00078 00079 00080 #if !defined(ENDOFENTITYEXCEPTION_HPP) 00081 #define ENDOFENTITYEXCEPTION_HPP 00082 00083 class XMLEntityDecl; 00084 00085 // 00086 // This class is only used internally. Its thrown by the ReaderMgr class, 00087 // when an entity ends, and is caught in the scanner. This tells the scanner 00088 // that an entity has ended, and allows it to do the right thing according 00089 // to what was going on when the entity ended. 00090 // 00091 // Since its internal, it does not bother implementing XMLException. 00092 // 00093 class XMLPARSER_EXPORT EndOfEntityException 00094 { 00095 public: 00096 // ----------------------------------------------------------------------- 00097 // Constructors and Destructor 00098 // ----------------------------------------------------------------------- 00099 EndOfEntityException( XMLEntityDecl* entityThatEnded 00100 , const unsigned int readerNum) : 00101 00102 fEntity(entityThatEnded) 00103 , fReaderNum(readerNum) 00104 { 00105 } 00106 00107 EndOfEntityException(const EndOfEntityException& toCopy) : 00108 00109 fEntity(toCopy.fEntity) 00110 , fReaderNum(toCopy.fReaderNum) 00111 { 00112 } 00113 00114 ~EndOfEntityException() 00115 { 00116 } 00117 00118 00119 // ----------------------------------------------------------------------- 00120 // Getter methods 00121 // ----------------------------------------------------------------------- 00122 XMLEntityDecl& getEntity(); 00123 const XMLEntityDecl& getEntity() const; 00124 unsigned int getReaderNum() const; 00125 00126 00127 private : 00128 // ----------------------------------------------------------------------- 00129 // Private data members 00130 // 00131 // fEntity 00132 // This is a reference to the entity that ended, causing this 00133 // exception. 00134 // 00135 // fReaderNum 00136 // The unique reader number of the reader that was handling this 00137 // entity. This is used to know whether a particular entity has 00138 // ended. 00139 // ----------------------------------------------------------------------- 00140 XMLEntityDecl* fEntity; 00141 unsigned int fReaderNum; 00142 }; 00143 00144 00145 // --------------------------------------------------------------------------- 00146 // EndOfEntityException: Getter methods 00147 // --------------------------------------------------------------------------- 00148 inline XMLEntityDecl& EndOfEntityException::getEntity() 00149 { 00150 return *fEntity; 00151 } 00152 00153 inline const XMLEntityDecl& EndOfEntityException::getEntity() const 00154 { 00155 return *fEntity; 00156 } 00157 00158 inline unsigned int EndOfEntityException::getReaderNum() const 00159 { 00160 return fReaderNum; 00161 } 00162 00163 #endif