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: RefVectorOf.hpp,v $
00059 * Revision 1.4 2000/03/02 19:54:45 roddey
00060 * This checkin includes many changes done while waiting for the
00061 * 1.1.0 code to be finished. I can't list them all here, but a list is
00062 * available elsewhere.
00063 *
00064 * Revision 1.3 2000/02/24 20:05:25 abagchi
00065 * Swat for removing Log from API docs
00066 *
00067 * Revision 1.2 2000/02/06 07:48:03 rahulj
00068 * Year 2K copyright swat.
00069 *
00070 * Revision 1.1.1.1 1999/11/09 01:05:05 twl
00071 * Initial checkin
00072 *
00073 * Revision 1.2 1999/11/08 20:45:13 rahul
00074 * Swat for adding in Product name and CVS comment log variable.
00075 *
00076 */
00077
00078 #if !defined(REFVECTOROF_HPP)
00079 #define REFVECTOROF_HPP
00080
00081 #include <util/XercesDefs.hpp>
00082 #include <util/ArrayIndexOutOfBoundsException.hpp>
00083 #include <util/XMLEnumerator.hpp>
00084
00085
00086 template <class TElem> class RefVectorOf
00087 {
00088 public :
00089 // -----------------------------------------------------------------------
00090 // Constructors and Destructor
00091 // -----------------------------------------------------------------------
00092 RefVectorOf(const unsigned int maxElems, const bool adoptElems = true);
00093 ~RefVectorOf();
00094
00095
00096 // -----------------------------------------------------------------------
00097 // Element management
00098 // -----------------------------------------------------------------------
00099 void addElement(TElem* const toAdd);
00100 void setElementAt(TElem* const toSet, const unsigned int setAt);
00101 void insertElementAt(TElem* const toInsert, const unsigned int insertAt);
00102 TElem* orphanElementAt(const unsigned int orphanAt);
00103 void removeAllElements();
00104 void removeElementAt(const unsigned int removeAt);
00105 void removeLastElement();
00106
00107
00108 // -----------------------------------------------------------------------
00109 // Getter methods
00110 // -----------------------------------------------------------------------
00111 unsigned int curCapacity() const;
00112 const TElem* elementAt(const unsigned int getAt) const;
00113 TElem* elementAt(const unsigned int getAt);
00114 unsigned int size() const;
00115
00116
00117 // -----------------------------------------------------------------------
00118 // Miscellaneous
00119 // -----------------------------------------------------------------------
00120 void ensureExtraCapacity(const unsigned int length);
00121
00122
00123 private:
00124 // -----------------------------------------------------------------------
00125 // Data members
00126 // -----------------------------------------------------------------------
00127 bool fAdoptedElems;
00128 unsigned int fCurCount;
00129 unsigned int fMaxCount;
00130 TElem** fElemList;
00131 };
00132
00133
00134 //
00135 // An enumerator for a reference vector. It derives from the basic enumerator
00136 // class, so that value vectors can be generically enumerated.
00137 //
00138 template <class TElem> class RefVectorEnumerator : public XMLEnumerator<TElem>
00139 {
00140 public :
00141 // -----------------------------------------------------------------------
00142 // Constructors and Destructor
00143 // -----------------------------------------------------------------------
00144 RefVectorEnumerator
00145 (
00146 RefVectorOf<TElem>* const toEnum
00147 , const bool adopt = false
00148 );
00149 ~RefVectorEnumerator();
00150
00151
00152 // -----------------------------------------------------------------------
00153 // Enum interface
00154 // -----------------------------------------------------------------------
00155 bool hasMoreElements() const;
00156 TElem& nextElement();
00157 void Reset();
00158
00159
00160 private :
00161 // -----------------------------------------------------------------------
00162 // Data Members
00163 //
00164 // fAdopted
00165 // Indicates whether we have adopted the passed vector. If so then
00166 // we delete the vector when we are destroyed.
00167 //
00168 // fCurIndex
00169 // This is the current index into the vector.
00170 //
00171 // fToEnum
00172 // The reference vector being enumerated.
00173 // -----------------------------------------------------------------------
00174 bool fAdopted;
00175 unsigned int fCurIndex;
00176 RefVectorOf<TElem>* fToEnum;
00177 };
00178
00179 #if !defined(XERCES_TMPLSINC)
00180 #include <util/RefVectorOf.c>
00181 #endif
00182
00183 #endif