Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XalanFStreamOutputStream.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XALANFSTREAMOUTPUTSTREAM_HEADER_GUARD_1357924680)
19 #define XALANFSTREAMOUTPUTSTREAM_HEADER_GUARD_1357924680
20 
21 
22 
23 // Base include file. Must be first.
25 
26 
27 
28 #include <cstdio>
29 
30 
31 
32 // Base class header file.
34 
35 
36 
37 XALAN_CPP_NAMESPACE_BEGIN
38 
39 #if defined(XALAN_STRICT_ANSI_HEADERS)
40 using std::FILE;
41 #endif
42 
44 {
45 public :
46 
47  enum { eDefaultBufferSize = 8192u };
48 
49 
50  /**
51  * Construct a XalanFStreamOutputStream object.
52  *
53  * @param theHandle handle of file. Must not be null.
54  * @param theBufferSize The size of the transcoding buffer
55  */
57  FILE* theFileHandle,
58  MemoryManager& theManager,
59  size_type theBufferSize = eDefaultBufferSize);
60 
62  create(
63  FILE* theFileHandle,
64  MemoryManager& theManager,
65  size_type theBufferSize = eDefaultBufferSize);
66 
67  virtual
69 
71  {
72  public:
73 
74  /**
75  * Construct an XalanFStreamOutputStreamWriteException exception object for an exception
76  * that occurred while writing to a file stream.
77  *
78  * @param theErrorCode number of error encountered
79  */
81  int theErrorCode,
82  XalanDOMString& theBuffer);
83 
84  virtual
86 
87  virtual const XalanDOMChar*
88  getType() const
89  {
90  return m_type;
91  }
92 
93  private:
94  static const XalanDOMChar m_type[];
95  };
96 
97 protected:
98 
99  virtual void
100  writeData(
101  const char* theBuffer,
102  size_type theBufferLength);
103 
104  virtual void
105  doFlush();
106 
107 private:
108 
109  // These are not implemented...
111 
113  operator=(const XalanFStreamOutputStream&);
114 
115  bool
116  operator==(const XalanFStreamOutputStream&) const;
117 
118 
119  // Data members...
120  FILE* const m_handle;
121 };
122 
123 
124 
125 XALAN_CPP_NAMESPACE_END
126 
127 
128 
129 #endif // XALANFSTREAMOUTPUTSTREAM_HEADER_GUARD_1357924680
virtual const XalanDOMChar * getType() const
Retrieve type of exception.
XalanTranscodingServices::size_type size_type
virtual void doFlush()=0
Flush the stream.
bool operator==(const ElemAttributeSet &theLHS, const ElemAttributeSet &theRHS)
#define XALAN_PLATFORMSUPPORT_EXPORT
virtual void writeData(const char *theBuffer, size_type theBufferLength)=0
Write the data in the buffer.

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo