Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

XalanFileOutputStream.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(XALANFILEOUTPUTSTREAM_HEADER_GUARD_1357924680)
00058 #define XALANFILEOUTPUTSTREAM_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #if defined(WIN32)
00068 #include <windows.h>
00069 #else
00070 #include <cstdio>
00071 #endif
00072 
00073 #include <vector>
00074 
00075 
00076 
00077 // Base class header file.
00078 #include <PlatformSupport/XalanOutputStream.hpp>
00079 
00080 
00081 
00082 class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStream : public XalanOutputStream
00083 {
00084 public :
00085 
00086     enum { eDefaultBufferSize = 8192 };
00087 
00094     XalanFileOutputStream(
00095             const XalanDOMString&   theFileName,
00096             unsigned int            theBufferSize = eDefaultBufferSize);
00097 
00098     virtual
00099     ~XalanFileOutputStream();
00100 
00101 
00102     class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStreamOpenException : public XalanOutputStream::XalanOutputStreamException
00103     {
00104     public:
00105 
00113         XalanFileOutputStreamOpenException(
00114             const XalanDOMString&   theFileName,
00115             int                     theErrorCode);
00116 
00117         virtual
00118         ~XalanFileOutputStreamOpenException();
00119     };
00120 
00121     class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStreamWriteException : public XalanOutputStream::XalanOutputStreamException
00122     {
00123     public:
00124 
00132         XalanFileOutputStreamWriteException(
00133             const XalanDOMString&   theFileName,
00134             int                     theErrorCode);
00135 
00136         virtual
00137         ~XalanFileOutputStreamWriteException();
00138     };
00139 
00140 protected:
00141 
00142     virtual void
00143     writeData(
00144             const char*     theBuffer,
00145             unsigned long   theBufferLength);
00146 
00147     virtual void
00148     doFlush();
00149 
00150 private:
00151 
00152     // These are not implemented...
00153     XalanFileOutputStream(const XalanFileOutputStream&);
00154 
00155     XalanFileOutputStream&
00156     operator=(const XalanFileOutputStream&);
00157 
00158     bool
00159     operator==(const XalanFileOutputStream&) const;
00160 
00161 
00162     // Data members...
00163     const XalanDOMString    m_fileName;
00164 
00165 #if defined(WIN32)
00166     const HANDLE            m_handle;
00167 #else
00168     FILE*                   m_handle;
00169 #endif
00170 };
00171 
00172 
00173 
00174 #endif  // XALANFILEOUTPUTSTREAM_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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.