Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

DOMStringPrintWriter.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 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(DOMSTRING_PRINTWRITER_HEADER_GUARD_1357924680)
00058 #define DOMSTRING_PRINTWRITER_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 
00068 
00069 
00070 #include <PlatformSupport/PrintWriter.hpp>
00071 
00072 
00073 
00074 #include <XalanDOM/XalanDOMString.hpp>
00075 
00076 
00077 
00078 class XALAN_PLATFORMSUPPORT_EXPORT DOMStringPrintWriter : public PrintWriter
00079 {
00080 public:
00081 
00082     // If a string is passed in, a copy will be made, and all
00083     // output will be appended to that string.
00084     explicit
00085     DOMStringPrintWriter(const XalanDOMString&  theBaseString = XalanDOMString());
00086 
00087     virtual
00088     ~DOMStringPrintWriter();
00089 
00090     const XalanDOMString&
00091     getString() const
00092     {
00093         return m_outputString;
00094     }
00095 
00096 
00097     // Output functions inherited from PrintWriter...
00098 
00099     // Flush the stream, then check the error status.
00100     virtual bool
00101     checkError() const;
00102 
00103     virtual void
00104     close();
00105 
00106     virtual void
00107     flush();
00108 
00109 
00110     // Output functions
00111 
00112     // If the length is UINT_MAX, then the array is assumed to be null-terminated.
00113     virtual void
00114     write(const char*   s,
00115           unsigned int  theOffset = 0,
00116           unsigned int  theLength = UINT_MAX);
00117 
00118     // If the length is UINT_MAX, then the array is assumed to be null-terminated.
00119     virtual void
00120     write(const XalanDOMChar*   s,
00121           unsigned int          theOffset = 0,
00122           unsigned int          theLength = UINT_MAX);
00123 
00124     virtual void
00125     write(XalanDOMChar  c);
00126 
00127     // If the length is UINT_MAX, then the entire string is printed.
00128     virtual void
00129     write(const XalanDOMString&     s,
00130           unsigned int              theOffset = 0,
00131           unsigned int              theLength = UINT_MAX);
00132 
00133 #if !defined(XALAN_BOOL_AS_INT)
00134     virtual void
00135     print(bool  b);
00136 #endif
00137 
00138     virtual void
00139     print(char  c);
00140 
00141     virtual void
00142     print(const char*   s,
00143           unsigned int  theLength = UINT_MAX);
00144 
00145     virtual void
00146     print(const XalanDOMChar*   s,
00147           unsigned int          theLength = UINT_MAX);
00148 
00149     virtual void
00150     print(double    d);
00151 
00152     virtual void
00153     print(int   i);
00154 
00155     virtual void
00156     print(long  l);
00157 
00158     virtual void
00159     print(const XalanDOMString&     s);
00160 
00161     virtual void
00162     println();
00163 
00164 #if !defined(XALAN_BOOL_AS_INT)
00165     virtual void
00166     println(bool    b);
00167 #endif
00168 
00169     virtual void
00170     println(char    c);
00171 
00172     virtual void
00173     println(const char*     s,
00174             unsigned int    theLength = UINT_MAX);
00175 
00176     virtual void
00177     println(const XalanDOMChar*     s,
00178             unsigned int            theLength = UINT_MAX);
00179 
00180     virtual void
00181     println(double  d);
00182 
00183     virtual void
00184     println(int     i);
00185 
00186     virtual void
00187     println(long    l);
00188 
00189     virtual void
00190     println(const XalanDOMString&   s);
00191 
00192 protected:
00193 
00194     XalanDOMString  m_outputString;
00195 
00196 private:
00197 
00198     // Not implemented
00199     DOMStringPrintWriter(const DOMStringPrintWriter&);
00200 
00201     DOMStringPrintWriter&
00202     operator=(const DOMStringPrintWriter&);
00203 
00204     bool
00205     operator==(const DOMStringPrintWriter&);
00206 };
00207 
00208 
00209 
00210 #endif  // DOMSTRING_PRINTWRITER_HEADER_GUARD_1357924680

Interpreting class diagrams

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

Xalan-C++ XSL Transformer Version 1.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.