blob: d2b651d085fe9ec3e6060e0f8545b44730e8592c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>activemq-cpp-3.4.0: src/main/decaf/io/Writer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">activemq-cpp-3.4.0</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_writer_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>src/main/decaf/io/Writer.h</h1> </div>
</div>
<div class="contents">
<a href="_writer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00006"></a>00006 <span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span>
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _DECAF_IO_WRITER_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _DECAF_IO_WRITER_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;decaf/io/IOException.h&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;decaf/io/Closeable.h&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;decaf/io/Flushable.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;decaf/lang/Appendable.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;decaf/lang/exceptions/NullPointerException.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;decaf/lang/exceptions/IndexOutOfBoundsException.h&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>decaf{
<a name="l00030"></a>00030 <span class="keyword">namespace </span>io{
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">/*</span>
<a name="l00033"></a>00033 <span class="comment"> * Abstract class for writing to character streams. The only methods that a</span>
<a name="l00034"></a>00034 <span class="comment"> * subclass must implement are write( char*, size_t, size_t ), flush(), and</span>
<a name="l00035"></a>00035 <span class="comment"> * close(). Most subclasses, however, will override some of the methods</span>
<a name="l00036"></a>00036 <span class="comment"> * defined here in order to provide higher efficiency, additional functionality,</span>
<a name="l00037"></a>00037 <span class="comment"> * or both.</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * @since 1.0</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a><a class="code" href="classdecaf_1_1io_1_1_writer.html">00041</a> <span class="keyword">class </span><a class="code" href="decaf_2util_2_config_8h.html#a8823395a34e3cba9af2a3d11968f3b37">DECAF_API</a> <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a> : <span class="keyword">public</span> decaf::io::<a class="code" href="classdecaf_1_1io_1_1_closeable.html" title="Interface for a class that implements the close method.">Closeable</a>,
<a name="l00042"></a>00042 <span class="keyword">public</span> decaf::io::<a class="code" href="classdecaf_1_1io_1_1_flushable.html" title="A Flushable is a destination of data that can be flushed.">Flushable</a>,
<a name="l00043"></a>00043 <span class="keyword">public</span> decaf::lang::Appendable {
<a name="l00044"></a>00044 <span class="keyword">private</span>:
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>&amp; );
<a name="l00047"></a>00047 <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>&amp; operator= ( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>&amp; );
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>();
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keyword">virtual</span> ~<a class="code" href="classdecaf_1_1io_1_1_writer.html">Writer</a>();
<a name="l00054"></a>00054
<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keywordtype">char</span> v );
<a name="l00064"></a>00064
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keyword">const</span> std::vector&lt;char&gt;&amp; buffer );
<a name="l00074"></a>00074
<a name="l00086"></a>00086 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size );
<a name="l00087"></a>00087
<a name="l00104"></a>00104 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size, <span class="keywordtype">int</span> offset, <span class="keywordtype">int</span> length );
<a name="l00105"></a>00105
<a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keyword">const</span> std::string&amp; str );
<a name="l00115"></a>00115
<a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> write( <span class="keyword">const</span> std::string&amp; str, <span class="keywordtype">int</span> offset, <span class="keywordtype">int</span> length );
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; append( <span class="keywordtype">char</span> value );
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; append( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_char_sequence.html" title="A CharSequence is a readable sequence of char values.">decaf::lang::CharSequence</a>* csq );
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; append( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_char_sequence.html" title="A CharSequence is a readable sequence of char values.">decaf::lang::CharSequence</a>* csq, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end );
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">protected</span>:
<a name="l00138"></a>00138
<a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteArrayBounded( <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size, <span class="keywordtype">int</span> offset, <span class="keywordtype">int</span> length ) = 0;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keyword">protected</span>:
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteChar( <span class="keywordtype">char</span> v );
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteVector( <span class="keyword">const</span> std::vector&lt;char&gt;&amp; buffer );
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteArray( <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size );
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteString( <span class="keyword">const</span> std::string&amp; str );
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">virtual</span> <span class="keywordtype">void</span> doWriteStringBounded( <span class="keyword">const</span> std::string&amp; str, <span class="keywordtype">int</span> offset, <span class="keywordtype">int</span> length );
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; doAppendChar( <span class="keywordtype">char</span> value );
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; doAppendCharSequence( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_char_sequence.html" title="A CharSequence is a readable sequence of char values.">decaf::lang::CharSequence</a>* csq );
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <a class="code" href="classdecaf_1_1lang_1_1_appendable.html" title="An object to which char sequences and values can be appended.">decaf::lang::Appendable</a>&amp; doAppendCharSequenceStartEnd( <span class="keyword">const</span> <a class="code" href="classdecaf_1_1lang_1_1_char_sequence.html" title="A CharSequence is a readable sequence of char values.">decaf::lang::CharSequence</a>* csq,
<a name="l00165"></a>00165 <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end );
<a name="l00166"></a>00166
<a name="l00167"></a>00167 };
<a name="l00168"></a>00168
<a name="l00169"></a>00169 }}
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="preprocessor">#endif </span><span class="comment">/*_DECAF_IO_WRITER_H*/</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_writer_8h.html">Writer.h</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>