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  

PrintWriter.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(PRINTWRITER_HEADER_GUARD_1357924680)
00058 #define PRINTWRITER_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 // Base class header file.
00068 #include <PlatformSupport/Writer.hpp>
00069 
00070 
00071 
00072 class XALAN_PLATFORMSUPPORT_EXPORT PrintWriter : public Writer
00073 {
00074 public:
00075 
00080     static void
00081     initialize();
00082 
00087     static void
00088     terminate();
00089 
00090 
00096     PrintWriter(bool    fAutoFlush = false);
00097 
00098     virtual
00099     ~PrintWriter();
00100 
00101     
00107     virtual bool
00108     checkError() const = 0;
00109 
00110     // Functions inherited from Writer...
00111 
00112     virtual void
00113     close() = 0;
00114 
00115     virtual void
00116     flush() = 0;
00117 
00118 
00119     // Output functions inherited from Writer...
00120 
00121     // If the length is UINT_MAX, then the array is assumed to be null-terminated.
00122     virtual void
00123     write(const char*   s,
00124           unsigned int  theOffset = 0,
00125           unsigned int  theLength = UINT_MAX) = 0;
00126 
00127     // If the length is UINT_MAX, then the array is assumed to be null-terminated.
00128     virtual void
00129     write(const XalanDOMChar*   s,
00130           unsigned int          theOffset = 0,
00131           unsigned int          theLength = UINT_MAX) = 0;
00132 
00133     virtual void
00134     write(XalanDOMChar  c) = 0;
00135 
00136     // If the length is UINT_MAX, then the entire string is printed.
00137     virtual void
00138     write(const XalanDOMString&     s,
00139           unsigned int              theOffset = 0,
00140           unsigned int              theLength = UINT_MAX) = 0;
00141 
00142     // Output functions which are new...
00143 
00144 #if !defined(XALAN_BOOL_AS_INT)
00145     virtual void
00146     print(bool  b) = 0;
00147 #endif
00148 
00149     virtual void
00150     print(char  c) = 0;
00151 
00152     virtual void
00153     print(const char*   s,
00154           unsigned int  theLength = UINT_MAX) = 0;
00155 
00156     virtual void
00157     print(const XalanDOMChar*   s,
00158           unsigned int          theLength = UINT_MAX) = 0;
00159 
00160     virtual void
00161     print(double    d) = 0;
00162 
00163     virtual void
00164     print(int   i) = 0;
00165 
00166     virtual void
00167     print(long  l) = 0;
00168 
00169     virtual void
00170     print(const XalanDOMString&     s) = 0;
00171 
00172     virtual void
00173     println() = 0;
00174 
00175 #if !defined(XALAN_BOOL_AS_INT)
00176     virtual void
00177     println(bool    b) = 0;
00178 #endif
00179 
00180     virtual void
00181     println(char    x) = 0;
00182 
00183     virtual void
00184     println(const char*     s,
00185             unsigned int    theLength = UINT_MAX) = 0;
00186 
00187     virtual void
00188     println(const XalanDOMChar*     s,
00189             unsigned int            theLength = UINT_MAX) = 0;
00190 
00191     virtual void
00192     println(double  x) = 0;
00193 
00194     virtual void
00195     println(int     x) = 0;
00196 
00197     virtual void
00198     println(long    x) = 0;
00199 
00200     virtual void
00201     println(const XalanDOMString&   s) = 0;
00202 
00203 protected:
00204 
00205     const bool                      m_fAutoFlush;
00206 
00207     // Some static strings to help derived classes...
00208     static const XalanDOMString&    s_trueString;
00209 
00210     static const XalanDOMString&    s_falseString;
00211 
00212     static const XalanDOMString&    s_newlineString;
00213 
00214 private:
00215 
00216     // Not implemented
00217     PrintWriter(const PrintWriter&);
00218 
00219     PrintWriter&
00220     operator=(const PrintWriter&);
00221 
00222     bool
00223     operator==(const PrintWriter&);
00224 };
00225 
00226 
00227 
00228 #endif  // 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.