Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

XalanFileOutputStream.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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 <xalanc/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 <xalanc/PlatformSupport/XalanOutputStream.hpp>
00079 
00080 
00081 
00082 XALAN_CPP_NAMESPACE_BEGIN
00083 
00084 
00085 
00086 class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStream : public XalanOutputStream
00087 {
00088 public :
00089 
00090     enum { eDefaultBufferSize = 8192 };
00091 
00092 #if defined(WIN32)
00093     typedef HANDLE  HandleType;
00094 #else
00095     typedef FILE*   HandleType;
00096 #endif
00097 
00104     XalanFileOutputStream(
00105             const XalanDOMString&   theFileName,
00106             unsigned int            theBufferSize = eDefaultBufferSize);
00107 
00108     virtual
00109     ~XalanFileOutputStream();
00110 
00111 
00112     class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStreamOpenException : public XalanOutputStream::XalanOutputStreamException
00113     {
00114     public:
00115 
00123         XalanFileOutputStreamOpenException(
00124             const XalanDOMString&   theFileName,
00125             int                     theErrorCode);
00126 
00127         virtual
00128         ~XalanFileOutputStreamOpenException();
00129     };
00130 
00131     class XALAN_PLATFORMSUPPORT_EXPORT XalanFileOutputStreamWriteException : public XalanOutputStream::XalanOutputStreamException
00132     {
00133     public:
00134 
00142         XalanFileOutputStreamWriteException(
00143             const XalanDOMString&   theFileName,
00144             int                     theErrorCode);
00145 
00146         virtual
00147         ~XalanFileOutputStreamWriteException();
00148     };
00149 
00150 protected:
00151 
00152     virtual void
00153     writeData(
00154             const char*     theBuffer,
00155             size_type       theBufferLength);
00156 
00157     virtual void
00158     doFlush();
00159 
00160 private:
00161 
00162     // These are not implemented...
00163     XalanFileOutputStream(const XalanFileOutputStream&);
00164 
00165     XalanFileOutputStream&
00166     operator=(const XalanFileOutputStream&);
00167 
00168     bool
00169     operator==(const XalanFileOutputStream&) const;
00170 
00171 
00172     // Data members...
00173     const XalanDOMString    m_fileName;
00174 
00175     const HandleType        m_handle;
00176 };
00177 
00178 
00179 
00180 XALAN_CPP_NAMESPACE_END
00181 
00182 
00183 
00184 #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++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.