Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

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

Writer.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(WRITER_HEADER_GUARD_1357924680)
00058 #define WRITER_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <cstddef>
00068 
00069 
00070 
00071 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 XALAN_CPP_NAMESPACE_BEGIN
00076 
00077 
00078 
00079 class XalanOutputStream;
00080 
00081 
00082 
00083 class XALAN_PLATFORMSUPPORT_EXPORT Writer
00084 {
00085 public:
00086 
00087     Writer();
00088 
00089     virtual
00090     ~Writer();
00091 
00095     virtual void
00096     close() = 0;
00097 
00101     virtual void
00102     flush() = 0;
00103 
00107     virtual XalanOutputStream*
00108     getStream();
00109 
00113     virtual const XalanOutputStream*
00114     getStream() const;
00115 
00116 
00117     // Output functions
00118 
00119 #if defined(XALAN_INLINE_INITIALIZATION)
00120     static const size_t     npos = ~0u;
00121 #else
00122     static const size_t     npos;
00123 #endif
00124 
00132     virtual void
00133     write(
00134             const char*     s,
00135             size_t          theOffset = 0,
00136             size_t          theLength = npos) = 0;
00137 
00145     virtual void
00146     write(
00147             const XalanDOMChar*         s,
00148             XalanDOMString::size_type   theOffset = 0,
00149             XalanDOMString::size_type   theLength = XalanDOMString::npos) = 0;
00150 
00156     virtual void
00157     write(XalanDOMChar  c) = 0;
00158 
00166     virtual void
00167     write(
00168             const XalanDOMString&       s,
00169             XalanDOMString::size_type   theOffset = 0,
00170             XalanDOMString::size_type   theLength = XalanDOMString::npos) = 0;
00171 
00172 private:
00173 
00174     // Not implemented
00175     Writer(const Writer&);
00176 
00177     Writer&
00178     operator=(const Writer&);
00179 
00180     bool
00181     operator==(const Writer&);
00182 };
00183 
00184 
00185 
00186 XALAN_CPP_NAMESPACE_END
00187 
00188 
00189 
00190 #endif  // WRITER_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.