## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.7

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XalanDOMStringCache.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  *
    00005  * Copyright (c) 1999-2004 The Apache Software Foundation.  All rights
    00006  * reserved.
    00007  *
    00008  * Redistribution and use in source and binary forms, with or without
    00009  * modification, are permitted provided that the following conditions
    00010  * are met:
    00011  *
    00012  * 1. Redistributions of source code must retain the above copyright
    00013  *    notice, this list of conditions and the following disclaimer.
    00014  *
    00015  * 2. Redistributions in binary form must reproduce the above copyright
    00016  *    notice, this list of conditions and the following disclaimer in
    00017  *    the documentation and/or other materials provided with the
    00018  *    distribution.
    00019  *
    00020  * 3. The end-user documentation included with the redistribution,
    00021  *    if any, must include the following acknowledgment:
    00022  *       "This product includes software developed by the
    00023  *        Apache Software Foundation (http://www.apache.org/)."
    00024  *    Alternately, this acknowledgment may appear in the software itself,
    00025  *    if and wherever such third-party acknowledgments normally appear.
    00026  *
    00027  * 4. The names "Xalan" and "Apache Software Foundation" must
    00028  *    not be used to endorse or promote products derived from this
    00029  *    software without prior written permission. For written
    00030  *    permission, please contact apache@apache.org.
    00031  *
    00032  * 5. Products derived from this software may not be called "Apache",
    00033  *    nor may "Apache" appear in their name, without prior written
    00034  *    permission of the Apache Software Foundation.
    00035  *
    00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00047  * SUCH DAMAGE.
    00048  * ====================================================================
    00049  *
    00050  * This software consists of voluntary contributions made by many
    00051  * individuals on behalf of the Apache Software Foundation and was
    00052  * originally based on software copyright (c) 1999, International
    00053  * Business Machines, Inc., http://www.ibm.com.  For more
    00054  * information on the Apache Software Foundation, please see
    00055  * <http://www.apache.org/>.
    00056  */
    00057 #if !defined(XALAN_DOMSTRINGCACHE_HEADER_GUARD)
    00058 #define XALAN_DOMSTRINGCACHE_HEADER_GUARD
    00059
    00060
    00061
    00062 // Base include file.  Must be first.
    00063 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
    00064
    00065
    00066
    00067 #include <deque>
    00068 #include <vector>
    00069
    00070
    00071
    00072 #include <xalanc/XalanDOM/XalanDOMString.hpp>
    00073
    00074
    00075
    00076 XALAN_CPP_NAMESPACE_BEGIN
    00077
    00078
    00079
    00080 class XALAN_PLATFORMSUPPORT_EXPORT XalanDOMStringCache
    00081 {
    00082 public:
    00083
    00084     enum { eDefaultMaximumSize = 100 };
    00085
    00086 #if defined(XALAN_NO_STD_NAMESPACE)
    00087     typedef vector<XalanDOMString*>         StringListType;
    00088 #else
    00089     typedef std::vector<XalanDOMString*>    StringListType;
    00090 #endif
    00091
    00092     explicit
    00093     XalanDOMStringCache(unsigned int    theMaximumSize = eDefaultMaximumSize);
    00094
    00095     ~XalanDOMStringCache();
    00096
    00097     unsigned int
    00098     getMaximumSize() const
    00099     {
    00100         return m_maximumSize;
    00101     }
    00102
    00103     void
    00104     setMaximumSize(unsigned int     theSize)
    00105     {
    00106         m_maximumSize = theSize;
    00107     }
    00108
    00109     XalanDOMString&
    00110     get();
    00111
    00112     bool
    00113     release(XalanDOMString&     theString);
    00114
    00115     /*
    00116      * Clear all of the strings in the cache.  This
    00117      * destroys all of the strings.
    00118      *
    00119      */
    00120     void
    00121     clear();
    00122
    00123     /*
    00124      * Reset the cache so that all strings that are
    00125      * currently in use are available.
    00126      */
    00127     void
    00128     reset();
    00129
    00130     class GetAndRelease
    00131     {
    00132     public:
    00133
    00134         GetAndRelease(XalanDOMStringCache&  theCache) :
    00135             m_cache(theCache),
    00136             m_string(&theCache.get())
    00137         {
    00138         }
    00139
    00140         ~GetAndRelease()
    00141         {
    00142             m_cache.release(*m_string);
    00143         }
    00144
    00145         XalanDOMString&
    00146         get() const
    00147         {
    00148             return *m_string;
    00149         }
    00150
    00151     private:
    00152
    00153         XalanDOMStringCache&    m_cache;
    00154
    00155         XalanDOMString* const   m_string;
    00156     };
    00157
    00158 private:
    00159
    00160     // not implemented
    00161     XalanDOMStringCache(const XalanDOMStringCache&);
    00162
    00163     bool
    00164     operator==(const XalanDOMStringCache&) const;
    00165
    00166     XalanDOMStringCache&
    00167     operator=(const XalanDOMStringCache&);
    00168
    00172     StringListType  m_availableList;
    00173
    00177     StringListType  m_busyList;
    00178
    00179     unsigned int    m_maximumSize;
    00180 };
    00181
    00182
    00183
    00184 XALAN_CPP_NAMESPACE_END
    00185
    00186
    00187
    00188 #endif  // XALAN_RESULTNAMESPACESSTACK_HEADER_GUARD

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.7 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.