XMLAttDefList.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2003 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: XMLAttDefList.hpp,v $
00059  * Revision 1.7  2003/11/10 21:53:54  neilg
00060  * add a means of statelessly traversing attribute lists.  mark the enumeration-based means as deprecated, since those are not stateless
00061  *
00062  * Revision 1.6  2003/10/20 11:47:30  gareth
00063  * Constructor take memory manager and get method for it.
00064  *
00065  * Revision 1.5  2003/10/10 16:23:29  peiyongz
00066  * Implementation of Serialization/Deserialization
00067  *
00068  * Revision 1.4  2003/05/16 21:36:55  knoaman
00069  * Memory manager implementation: Modify constructors to pass in the memory manager.
00070  *
00071  * Revision 1.3  2003/05/15 18:26:07  knoaman
00072  * Partial implementation of the configurable memory manager.
00073  *
00074  * Revision 1.2  2002/11/04 15:00:21  tng
00075  * C++ Namespace Support.
00076  *
00077  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
00078  * sane_include
00079  *
00080  * Revision 1.4  2000/02/24 20:00:22  abagchi
00081  * Swat for removing Log from API docs
00082  *
00083  * Revision 1.3  2000/02/15 01:21:30  roddey
00084  * Some initial documentation improvements. More to come...
00085  *
00086  * Revision 1.2  2000/02/06 07:47:46  rahulj
00087  * Year 2K copyright swat.
00088  *
00089  * Revision 1.1.1.1  1999/11/09 01:08:28  twl
00090  * Initial checkin
00091  *
00092  * Revision 1.2  1999/11/08 20:44:35  rahul
00093  * Swat for adding in Product name and CVS comment log variable.
00094  *
00095  */
00096 
00097 #if !defined(XMLATTDEFLIST_HPP)
00098 #define XMLATTDEFLIST_HPP
00099 
00100 #include <xercesc/util/XercesDefs.hpp>
00101 #include <xercesc/util/XMemory.hpp>
00102 #include <xercesc/internal/XSerializable.hpp>
00103 
00104 XERCES_CPP_NAMESPACE_BEGIN
00105 
00106 class XMLAttDef;
00107 
00125 class  XMLAttDefList : public XSerializable, public XMemory
00126 {
00127 public:
00128     // -----------------------------------------------------------------------
00129     //  Constructors and Destructor
00130     // -----------------------------------------------------------------------
00131 
00134     virtual ~XMLAttDefList();
00136 
00137 
00138     // -----------------------------------------------------------------------
00139     //  The virtual interface
00140     // -----------------------------------------------------------------------
00141 
00145     virtual bool hasMoreElements() const = 0;
00146     virtual bool isEmpty() const = 0;
00147     virtual XMLAttDef* findAttDef
00148     (
00149         const   unsigned long       uriID
00150         , const XMLCh* const        attName
00151     ) = 0;
00152     virtual const XMLAttDef* findAttDef
00153     (
00154         const   unsigned long       uriID
00155         , const XMLCh* const        attName
00156     )   const = 0;
00157     virtual XMLAttDef* findAttDef
00158     (
00159         const   XMLCh* const        attURI
00160         , const XMLCh* const        attName
00161     ) = 0;
00162     virtual const XMLAttDef* findAttDef
00163     (
00164         const   XMLCh* const        attURI
00165         , const XMLCh* const        attName
00166     )   const = 0;
00167 
00171     virtual XMLAttDef& nextElement() = 0;
00172 
00176     virtual void Reset() = 0;
00177 
00181     virtual unsigned int getAttDefCount() const = 0;
00182 
00186     virtual XMLAttDef &getAttDef(unsigned int index) = 0;
00187 
00191     virtual const XMLAttDef &getAttDef(unsigned int index) const = 0;
00192 
00193     /***
00194      * Support for Serialization/De-serialization
00195      ***/
00196     DECL_XSERIALIZABLE(XMLAttDefList)
00197 
00198 
00199     // -----------------------------------------------------------------------
00200     //  Getter methods
00201     // -----------------------------------------------------------------------
00202 
00205 
00213     MemoryManager* getMemoryManager() const;
00214 
00216 
00217 protected :
00218     // -----------------------------------------------------------------------
00219     //  Hidden constructors and operators
00220     // -----------------------------------------------------------------------
00221     XMLAttDefList(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
00222     XMLAttDefList(const XMLAttDefList&);
00223     XMLAttDefList& operator=(const XMLAttDefList&);
00224 
00225 
00226 private:
00227     MemoryManager*      fMemoryManager;
00228 };
00229 
00230 
00231 
00232 // ---------------------------------------------------------------------------
00233 //  XMLAttDefList: Getter methods
00234 // ---------------------------------------------------------------------------
00235 
00236 inline MemoryManager* XMLAttDefList::getMemoryManager() const
00237 {
00238     return fMemoryManager;
00239 }
00240 
00241 // ---------------------------------------------------------------------------
00242 //  XMLAttDefList: Constructors and Destructor
00243 // ---------------------------------------------------------------------------
00244 inline XMLAttDefList::~XMLAttDefList()
00245 {
00246 }
00247 
00248 
00249 // ---------------------------------------------------------------------------
00250 //  XMLAttDefList: Hidden Constructors and Operators
00251 // ---------------------------------------------------------------------------
00252 inline XMLAttDefList::XMLAttDefList(MemoryManager* const manager):
00253 fMemoryManager(manager)
00254 {
00255 }
00256 
00257 inline XMLAttDefList::XMLAttDefList(const XMLAttDefList&)
00258 {
00259 }
00260 
00261 inline XMLAttDefList& XMLAttDefList::operator=(const XMLAttDefList&)
00262 {
00263     return *this;
00264 }
00265 
00266 XERCES_CPP_NAMESPACE_END
00267 
00268 #endif