diff options
| author | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
|---|---|---|
| committer | Silvio <silvio@devlet.com.br> | 2010-08-20 15:39:56 -0300 |
| commit | b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a (patch) | |
| tree | 5fd92d1ec675d64bf1a79e8f246a99c2e47f8e2b /doc/html/classorg_1_1openisis_1_1PlainSerializer.html | |
| parent | 298ac8892db90e518da71540c8fab72f885d66ff (diff) | |
| download | cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.gz cinisis-b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a.tar.bz2 | |
Adding generated docs
Diffstat (limited to 'doc/html/classorg_1_1openisis_1_1PlainSerializer.html')
| -rw-r--r-- | doc/html/classorg_1_1openisis_1_1PlainSerializer.html | 412 |
1 files changed, 412 insertions, 0 deletions
diff --git a/doc/html/classorg_1_1openisis_1_1PlainSerializer.html b/doc/html/classorg_1_1openisis_1_1PlainSerializer.html new file mode 100644 index 0000000..f6b1148 --- /dev/null +++ b/doc/html/classorg_1_1openisis_1_1PlainSerializer.html @@ -0,0 +1,412 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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>IsisReader: org::openisis::PlainSerializer Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><b>org</b>::<b>openisis</b>::<a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">PlainSerializer</a> + </div> +</div> +<div class="contents"> +<h1>org::openisis::PlainSerializer Class Reference</h1><!-- doxytag: class="org::openisis::PlainSerializer" --> +<p><a href="classorg_1_1openisis_1_1PlainSerializer-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>ByteBuf</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>ProtocolViolation</b></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b>PSWriter</b></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a81e10ddbe85c7a1b13e491f68499f01a">flush</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a0429e76f69a219a389f97448d056d61c">write</a> (<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> fld)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a6ec44dbc70ea599151082b82b9acb50c">write</a> (<a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[] flds)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a59e5c3d513b1a61bb3a4c922e5f2213b">read</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c17fbd9167aa5fdd22b296ef38119a2"></a><!-- doxytag: member="org::openisis::PlainSerializer::setBinaryMode" ref="a5c17fbd9167aa5fdd22b296ef38119a2" args="(boolean bin)" --> +void </td><td class="memItemRight" valign="bottom"><b>setBinaryMode</b> (boolean bin)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a4424e6206c0b7c0001c8cf01bf7d1106">setEncoding</a> (String enc)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a4e4ed863fda3f9820cb04d941804f2bd">PlainSerializer</a> (InputStream in, OutputStream out, String enc, boolean bin)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a0c19333f7b3223c3d507b0535d002fe8">PlainSerializer</a> (InputStream in, OutputStream out)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a22f9b942c6bc46622b152299434c28c2">PlainSerializer</a> (String hostname, int port, String enc, boolean bin) throws Exception </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a55b2ac6e1b9dd1b02bcf87ad2a4d0745">PlainSerializer</a> (String hostname, int port) throws Exception </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#aee2227eb4696c0d2bd9350dde038bd1f">close</a> ()</td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html#a0f1e2ac08d3e969114cf651ca5e03703">main</a> (String argv[])</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>Serialization of fields by plain protocol. </p> +<dl class="rcs"><dt><b>Id</b></dt><dd>PlainSerializer.java,v 1.8 2003/05/02 18:41:55 mawag <a class="el" href="unionExp.html">Exp</a> </dd></dl> +<dl class="version"><dt><b>Version:</b></dt><dd></dd></dl> +<dl class="rcs"><dt><b>Revision</b></dt><dd>1.8 </dd></dl> +<dl class="author"><dt><b>Author:</b></dt><dd></dd></dl> +<dl class="rcs"><dt><b>Author</b></dt><dd>mawag </dd></dl> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a4e4ed863fda3f9820cb04d941804f2bd"></a><!-- doxytag: member="org::openisis::PlainSerializer::PlainSerializer" ref="a4e4ed863fda3f9820cb04d941804f2bd" args="(InputStream in, OutputStream out, String enc, boolean bin)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">org::openisis::PlainSerializer::PlainSerializer </td> + <td>(</td> + <td class="paramtype">InputStream </td> + <td class="paramname"> <em>in</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">OutputStream </td> + <td class="paramname"> <em>out</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"> <em>enc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"> <em>bin</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor with read and write stream. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>enc</em> </td><td>character encoding </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>binary mode </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a0c19333f7b3223c3d507b0535d002fe8"></a><!-- doxytag: member="org::openisis::PlainSerializer::PlainSerializer" ref="a0c19333f7b3223c3d507b0535d002fe8" args="(InputStream in, OutputStream out)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">org::openisis::PlainSerializer::PlainSerializer </td> + <td>(</td> + <td class="paramtype">InputStream </td> + <td class="paramname"> <em>in</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">OutputStream </td> + <td class="paramname"> <em>out</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor using text mode and platforms default encoding. </p> + +</div> +</div> +<a class="anchor" id="a22f9b942c6bc46622b152299434c28c2"></a><!-- doxytag: member="org::openisis::PlainSerializer::PlainSerializer" ref="a22f9b942c6bc46622b152299434c28c2" args="(String hostname, int port, String enc, boolean bin)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">org::openisis::PlainSerializer::PlainSerializer </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>hostname</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"> <em>enc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">boolean </td> + <td class="paramname"> <em>bin</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> throws Exception <code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor for a socket connection to port. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>enc</em> </td><td>character encoding </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bin</em> </td><td>binary mode </td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>all</em> </td><td>exceptions a socket might throw </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a55b2ac6e1b9dd1b02bcf87ad2a4d0745"></a><!-- doxytag: member="org::openisis::PlainSerializer::PlainSerializer" ref="a55b2ac6e1b9dd1b02bcf87ad2a4d0745" args="(String hostname, int port)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">org::openisis::PlainSerializer::PlainSerializer </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>hostname</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> throws Exception <code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Constructor using text mode and platforms default encoding. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aee2227eb4696c0d2bd9350dde038bd1f"></a><!-- doxytag: member="org::openisis::PlainSerializer::close" ref="aee2227eb4696c0d2bd9350dde038bd1f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void org::openisis::PlainSerializer::close </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Close communication channels. </p> + +</div> +</div> +<a class="anchor" id="a81e10ddbe85c7a1b13e491f68499f01a"></a><!-- doxytag: member="org::openisis::PlainSerializer::flush" ref="a81e10ddbe85c7a1b13e491f68499f01a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">boolean org::openisis::PlainSerializer::flush </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>write end of record to output stream. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>success </dd></dl> + +</div> +</div> +<a class="anchor" id="a0f1e2ac08d3e969114cf651ca5e03703"></a><!-- doxytag: member="org::openisis::PlainSerializer::main" ref="a0f1e2ac08d3e969114cf651ca5e03703" args="(String argv[])" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void org::openisis::PlainSerializer::main </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>argv</em>[]</td> + <td> ) </td> + <td><code> [inline, static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Tester:<br/> +</p> +<pre> + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -b -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-8 -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-8 -b -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-16 -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-16 -b -p + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -p 55 + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -b -p 55 + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-16 -p 55 + java <a class="el" href="classorg_1_1openisis_1_1PlainSerializer.html">org.openisis.PlainSerializer</a> -e UTF-16 -b -p 55 + </pre> +</div> +</div> +<a class="anchor" id="a59e5c3d513b1a61bb3a4c922e5f2213b"></a><!-- doxytag: member="org::openisis::PlainSerializer::read" ref="a59e5c3d513b1a61bb3a4c922e5f2213b" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> [] org::openisis::PlainSerializer::read </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>deserialize fields. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>array of fields read from input stream, null on error </dd></dl> + +</div> +</div> +<a class="anchor" id="a4424e6206c0b7c0001c8cf01bf7d1106"></a><!-- doxytag: member="org::openisis::PlainSerializer::setEncoding" ref="a4424e6206c0b7c0001c8cf01bf7d1106" args="(String enc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void org::openisis::PlainSerializer::setEncoding </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"> <em>enc</em></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Set character encoding to use in subsequent calls to read and write. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>enc</em> </td><td>if null, the platforms default encoding will be used </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a6ec44dbc70ea599151082b82b9acb50c"></a><!-- doxytag: member="org::openisis::PlainSerializer::write" ref="a6ec44dbc70ea599151082b82b9acb50c" args="(Field[] flds)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">boolean org::openisis::PlainSerializer::write </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a>[] </td> + <td class="paramname"> <em>flds</em></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>serialize fields. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>success </dd></dl> + +</div> +</div> +<a class="anchor" id="a0429e76f69a219a389f97448d056d61c"></a><!-- doxytag: member="org::openisis::PlainSerializer::write" ref="a0429e76f69a219a389f97448d056d61c" args="(Field fld)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">boolean org::openisis::PlainSerializer::write </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classorg_1_1openisis_1_1Field.html">Field</a> </td> + <td class="paramname"> <em>fld</em></td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>serialize one field. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>success </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>contrib/openisis/org/openisis/PlainSerializer.java</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 30 14:47:17 2010 for IsisReader by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |