source: tags/0.5.5/doc/omq/common/util/Serializers/ISerializer.html

Last change on this file was 85, checked in by stoda, 11 years ago

Javadocs updated
File size: 10.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="es">
4<head>
5<!-- Generated by javadoc (version 1.7.0_25) on Wed Jul 10 13:13:17 CEST 2013 -->
6<title>ISerializer</title>
7<meta name="date" content="2013-07-10">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="ISerializer";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/ISerializer.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-files/index-1.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../../omq/common/util/Serializers/GsonImp.html" title="class in omq.common.util.Serializers"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../omq/common/util/Serializers/JavaImp.html" title="class in omq.common.util.Serializers"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?omq/common/util/Serializers/ISerializer.html" target="_top">Frames</a></li>
44<li><a href="ISerializer.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li>Constr&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li>Constr&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">omq.common.util.Serializers</div>
83<h2 title="Interface ISerializer" class="title">Interface ISerializer</h2>
84</div>
85<div class="contentContainer">
86<div class="description">
87<ul class="blockList">
88<li class="blockList">
89<dl>
90<dt>All Known Implementing Classes:</dt>
91<dd><a href="../../../../omq/common/util/Serializers/GsonImp.html" title="class in omq.common.util.Serializers">GsonImp</a>, <a href="../../../../omq/common/util/Serializers/JavaImp.html" title="class in omq.common.util.Serializers">JavaImp</a>, <a href="../../../../omq/common/util/Serializers/KryoImp.html" title="class in omq.common.util.Serializers">KryoImp</a></dd>
92</dl>
93<hr>
94<br>
95<pre>public interface <span class="strong">ISerializer</span></pre>
96<div class="block">An ISerializer object can serialize any kind of objects and deserialize
97 Requests and Responses.</div>
98<dl><dt><span class="strong">Author:</span></dt>
99  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd></dl>
100</li>
101</ul>
102</div>
103<div class="summary">
104<ul class="blockList">
105<li class="blockList">
106<!-- ========== METHOD SUMMARY =========== -->
107<ul class="blockList">
108<li class="blockList"><a name="method_summary">
109<!--   -->
110</a>
111<h3>Method Summary</h3>
112<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
113<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
114<tr>
115<th class="colFirst" scope="col">Modifier and Type</th>
116<th class="colLast" scope="col">Method and Description</th>
117</tr>
118<tr class="altColor">
119<td class="colFirst"><code><a href="../../../../omq/common/message/Request.html" title="class in omq.common.message">Request</a></code></td>
120<td class="colLast"><code><strong><a href="../../../../omq/common/util/Serializers/ISerializer.html#deserializeRequest(byte[], omq.server.RemoteObject)">deserializeRequest</a></strong>(byte[]&nbsp;bytes,
121                  <a href="../../../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)</code>
122<div class="block">Deserialize a Request</div>
123</td>
124</tr>
125<tr class="rowColor">
126<td class="colFirst"><code><a href="../../../../omq/common/message/Response.html" title="class in omq.common.message">Response</a></code></td>
127<td class="colLast"><code><strong><a href="../../../../omq/common/util/Serializers/ISerializer.html#deserializeResponse(byte[], java.lang.Class)">deserializeResponse</a></strong>(byte[]&nbsp;bytes,
128                   java.lang.Class&lt;?&gt;&nbsp;type)</code>
129<div class="block">Deserialize a Response</div>
130</td>
131</tr>
132<tr class="altColor">
133<td class="colFirst"><code>byte[]</code></td>
134<td class="colLast"><code><strong><a href="../../../../omq/common/util/Serializers/ISerializer.html#serialize(java.lang.Object)">serialize</a></strong>(java.lang.Object&nbsp;obj)</code>
135<div class="block">Serialize</div>
136</td>
137</tr>
138</table>
139</li>
140</ul>
141</li>
142</ul>
143</div>
144<div class="details">
145<ul class="blockList">
146<li class="blockList">
147<!-- ============ METHOD DETAIL ========== -->
148<ul class="blockList">
149<li class="blockList"><a name="method_detail">
150<!--   -->
151</a>
152<h3>Method Detail</h3>
153<a name="serialize(java.lang.Object)">
154<!--   -->
155</a>
156<ul class="blockList">
157<li class="blockList">
158<h4>serialize</h4>
159<pre>byte[]&nbsp;serialize(java.lang.Object&nbsp;obj)
160                 throws <a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
161<div class="block">Serialize</div>
162<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - - object to serialize</dd>
163<dt><span class="strong">Returns:</span></dt><dd>objectSerialized</dd>
164<dt><span class="strong">Throws:</span></dt>
165<dd><code><a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code> - - If the serialization failed</dd></dl>
166</li>
167</ul>
168<a name="deserializeRequest(byte[], omq.server.RemoteObject)">
169<!--   -->
170</a>
171<ul class="blockList">
172<li class="blockList">
173<h4>deserializeRequest</h4>
174<pre><a href="../../../../omq/common/message/Request.html" title="class in omq.common.message">Request</a>&nbsp;deserializeRequest(byte[]&nbsp;bytes,
175                         <a href="../../../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)
176                           throws <a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
177<div class="block">Deserialize a Request</div>
178<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - - serialized request</dd><dd><code>obj</code> - - remoteObject which is receiving requests</dd>
179<dt><span class="strong">Returns:</span></dt><dd>request</dd>
180<dt><span class="strong">Throws:</span></dt>
181<dd><code><a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code> - - If the serialization failed</dd></dl>
182</li>
183</ul>
184<a name="deserializeResponse(byte[], java.lang.Class)">
185<!--   -->
186</a>
187<ul class="blockListLast">
188<li class="blockList">
189<h4>deserializeResponse</h4>
190<pre><a href="../../../../omq/common/message/Response.html" title="class in omq.common.message">Response</a>&nbsp;deserializeResponse(byte[]&nbsp;bytes,
191                           java.lang.Class&lt;?&gt;&nbsp;type)
192                             throws <a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
193<div class="block">Deserialize a Response</div>
194<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - serialized response</dd><dd><code>type</code> - - return type expected</dd>
195<dt><span class="strong">Returns:</span></dt><dd>response</dd>
196<dt><span class="strong">Throws:</span></dt>
197<dd><code><a href="../../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code> - - If the serialization failed</dd></dl>
198</li>
199</ul>
200</li>
201</ul>
202</li>
203</ul>
204</div>
205</div>
206<!-- ========= END OF CLASS DATA ========= -->
207<!-- ======= START OF BOTTOM NAVBAR ====== -->
208<div class="bottomNav"><a name="navbar_bottom">
209<!--   -->
210</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
211<!--   -->
212</a>
213<ul class="navList" title="Navigation">
214<li><a href="../../../../overview-summary.html">Overview</a></li>
215<li><a href="package-summary.html">Package</a></li>
216<li class="navBarCell1Rev">Class</li>
217<li><a href="class-use/ISerializer.html">Use</a></li>
218<li><a href="package-tree.html">Tree</a></li>
219<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
220<li><a href="../../../../index-files/index-1.html">Index</a></li>
221<li><a href="../../../../help-doc.html">Help</a></li>
222</ul>
223</div>
224<div class="subNav">
225<ul class="navList">
226<li><a href="../../../../omq/common/util/Serializers/GsonImp.html" title="class in omq.common.util.Serializers"><span class="strong">Prev Class</span></a></li>
227<li><a href="../../../../omq/common/util/Serializers/JavaImp.html" title="class in omq.common.util.Serializers"><span class="strong">Next Class</span></a></li>
228</ul>
229<ul class="navList">
230<li><a href="../../../../index.html?omq/common/util/Serializers/ISerializer.html" target="_top">Frames</a></li>
231<li><a href="ISerializer.html" target="_top">No Frames</a></li>
232</ul>
233<ul class="navList" id="allclasses_navbar_bottom">
234<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
235</ul>
236<div>
237<script type="text/javascript"><!--
238  allClassesLink = document.getElementById("allclasses_navbar_bottom");
239  if(window==top) {
240    allClassesLink.style.display = "block";
241  }
242  else {
243    allClassesLink.style.display = "none";
244  }
245  //-->
246</script>
247</div>
248<div>
249<ul class="subNavList">
250<li>Summary:&nbsp;</li>
251<li>Nested&nbsp;|&nbsp;</li>
252<li>Field&nbsp;|&nbsp;</li>
253<li>Constr&nbsp;|&nbsp;</li>
254<li><a href="#method_summary">Method</a></li>
255</ul>
256<ul class="subNavList">
257<li>Detail:&nbsp;</li>
258<li>Field&nbsp;|&nbsp;</li>
259<li>Constr&nbsp;|&nbsp;</li>
260<li><a href="#method_detail">Method</a></li>
261</ul>
262</div>
263<a name="skip-navbar_bottom">
264<!--   -->
265</a></div>
266<!-- ======== END OF BOTTOM NAVBAR ======= -->
267</body>
268</html>
Note: See TracBrowser for help on using the repository browser.