source: trunk/doc/omq/common/util/Serializer.html

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

Javadocs updated
File size: 16.9 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>Serializer</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="Serializer";
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/Serializer.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/ParameterQueue.html" title="class in omq.common.util"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../omq/common/util/Zipper.html" title="class in omq.common.util"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../index.html?omq/common/util/Serializer.html" target="_top">Frames</a></li>
44<li><a href="Serializer.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&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><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&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</div>
83<h2 title="Class Serializer" class="title">Class Serializer</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li>java.lang.Object</li>
88<li>
89<ul class="inheritance">
90<li>omq.common.util.Serializer</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<hr>
98<br>
99<pre>public class <span class="strong">Serializer</span>
100extends java.lang.Object</pre>
101<div class="block">Serializer enables to serialize the requests and the responses of the
102 remoteObjects. This class is used to have the same serializer object a not to
103 create new instances every time they are needed.</div>
104<dl><dt><span class="strong">Author:</span></dt>
105  <dd>Sergi Toda <sergi.toda@estudiants.urv.cat></dd></dl>
106</li>
107</ul>
108</div>
109<div class="summary">
110<ul class="blockList">
111<li class="blockList">
112<!-- =========== FIELD SUMMARY =========== -->
113<ul class="blockList">
114<li class="blockList"><a name="field_summary">
115<!--   -->
116</a>
117<h3>Field Summary</h3>
118<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
119<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
120<tr>
121<th class="colFirst" scope="col">Modifier and Type</th>
122<th class="colLast" scope="col">Field and Description</th>
123</tr>
124<tr class="altColor">
125<td class="colFirst"><code>static java.lang.String</code></td>
126<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#GSON">GSON</a></strong></code>&nbsp;</td>
127</tr>
128<tr class="rowColor">
129<td class="colFirst"><code>static java.lang.String</code></td>
130<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#JAVA">JAVA</a></strong></code>&nbsp;</td>
131</tr>
132<tr class="altColor">
133<td class="colFirst"><code>static java.lang.String</code></td>
134<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#KRYO">KRYO</a></strong></code>&nbsp;</td>
135</tr>
136<tr class="rowColor">
137<td class="colFirst"><code><a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a></code></td>
138<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#serializer">serializer</a></strong></code>&nbsp;</td>
139</tr>
140</table>
141</li>
142</ul>
143<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144<ul class="blockList">
145<li class="blockList"><a name="constructor_summary">
146<!--   -->
147</a>
148<h3>Constructor Summary</h3>
149<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
150<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
151<tr>
152<th class="colOne" scope="col">Constructor and Description</th>
153</tr>
154<tr class="altColor">
155<td class="colOne"><code><strong><a href="../../../omq/common/util/Serializer.html#Serializer(java.util.Properties)">Serializer</a></strong>(java.util.Properties&nbsp;env)</code>&nbsp;</td>
156</tr>
157</table>
158</li>
159</ul>
160<!-- ========== METHOD SUMMARY =========== -->
161<ul class="blockList">
162<li class="blockList"><a name="method_summary">
163<!--   -->
164</a>
165<h3>Method Summary</h3>
166<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
167<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
168<tr>
169<th class="colFirst" scope="col">Modifier and Type</th>
170<th class="colLast" scope="col">Method and Description</th>
171</tr>
172<tr class="altColor">
173<td class="colFirst"><code><a href="../../../omq/common/message/Request.html" title="class in omq.common.message">Request</a></code></td>
174<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#deserializeRequest(java.lang.String, byte[], omq.server.RemoteObject)">deserializeRequest</a></strong>(java.lang.String&nbsp;type,
175                  byte[]&nbsp;bytes,
176                  <a href="../../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)</code>&nbsp;</td>
177</tr>
178<tr class="rowColor">
179<td class="colFirst"><code><a href="../../../omq/common/message/Response.html" title="class in omq.common.message">Response</a></code></td>
180<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#deserializeResponse(byte[], java.lang.Class)">deserializeResponse</a></strong>(byte[]&nbsp;bytes,
181                   java.lang.Class&lt;?&gt;&nbsp;type)</code>&nbsp;</td>
182</tr>
183<tr class="altColor">
184<td class="colFirst"><code><a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a></code></td>
185<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#getInstance()">getInstance</a></strong>()</code>&nbsp;</td>
186</tr>
187<tr class="rowColor">
188<td class="colFirst"><code><a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a></code></td>
189<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#getInstance(java.lang.String)">getInstance</a></strong>(java.lang.String&nbsp;type)</code>&nbsp;</td>
190</tr>
191<tr class="altColor">
192<td class="colFirst"><code>byte[]</code></td>
193<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#serialize(java.lang.Object)">serialize</a></strong>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
194</tr>
195<tr class="rowColor">
196<td class="colFirst"><code>byte[]</code></td>
197<td class="colLast"><code><strong><a href="../../../omq/common/util/Serializer.html#serialize(java.lang.String, java.lang.Object)">serialize</a></strong>(java.lang.String&nbsp;type,
198         java.lang.Object&nbsp;obj)</code>&nbsp;</td>
199</tr>
200</table>
201<ul class="blockList">
202<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
203<!--   -->
204</a>
205<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
206<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
207</ul>
208</li>
209</ul>
210</li>
211</ul>
212</div>
213<div class="details">
214<ul class="blockList">
215<li class="blockList">
216<!-- ============ FIELD DETAIL =========== -->
217<ul class="blockList">
218<li class="blockList"><a name="field_detail">
219<!--   -->
220</a>
221<h3>Field Detail</h3>
222<a name="KRYO">
223<!--   -->
224</a>
225<ul class="blockList">
226<li class="blockList">
227<h4>KRYO</h4>
228<pre>public static final&nbsp;java.lang.String KRYO</pre>
229<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#omq.common.util.Serializer.KRYO">Constant Field Values</a></dd></dl>
230</li>
231</ul>
232<a name="JAVA">
233<!--   -->
234</a>
235<ul class="blockList">
236<li class="blockList">
237<h4>JAVA</h4>
238<pre>public static final&nbsp;java.lang.String JAVA</pre>
239<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#omq.common.util.Serializer.JAVA">Constant Field Values</a></dd></dl>
240</li>
241</ul>
242<a name="GSON">
243<!--   -->
244</a>
245<ul class="blockList">
246<li class="blockList">
247<h4>GSON</h4>
248<pre>public static final&nbsp;java.lang.String GSON</pre>
249<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#omq.common.util.Serializer.GSON">Constant Field Values</a></dd></dl>
250</li>
251</ul>
252<a name="serializer">
253<!--   -->
254</a>
255<ul class="blockListLast">
256<li class="blockList">
257<h4>serializer</h4>
258<pre>public&nbsp;<a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a> serializer</pre>
259</li>
260</ul>
261</li>
262</ul>
263<!-- ========= CONSTRUCTOR DETAIL ======== -->
264<ul class="blockList">
265<li class="blockList"><a name="constructor_detail">
266<!--   -->
267</a>
268<h3>Constructor Detail</h3>
269<a name="Serializer(java.util.Properties)">
270<!--   -->
271</a>
272<ul class="blockListLast">
273<li class="blockList">
274<h4>Serializer</h4>
275<pre>public&nbsp;Serializer(java.util.Properties&nbsp;env)</pre>
276</li>
277</ul>
278</li>
279</ul>
280<!-- ============ METHOD DETAIL ========== -->
281<ul class="blockList">
282<li class="blockList"><a name="method_detail">
283<!--   -->
284</a>
285<h3>Method Detail</h3>
286<a name="getInstance()">
287<!--   -->
288</a>
289<ul class="blockList">
290<li class="blockList">
291<h4>getInstance</h4>
292<pre>public&nbsp;<a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a>&nbsp;getInstance()
293                        throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
294<dl><dt><span class="strong">Throws:</span></dt>
295<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
296</li>
297</ul>
298<a name="getInstance(java.lang.String)">
299<!--   -->
300</a>
301<ul class="blockList">
302<li class="blockList">
303<h4>getInstance</h4>
304<pre>public&nbsp;<a href="../../../omq/common/util/Serializers/ISerializer.html" title="interface in omq.common.util.Serializers">ISerializer</a>&nbsp;getInstance(java.lang.String&nbsp;type)
305                        throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
306<dl><dt><span class="strong">Throws:</span></dt>
307<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
308</li>
309</ul>
310<a name="serialize(java.lang.String, java.lang.Object)">
311<!--   -->
312</a>
313<ul class="blockList">
314<li class="blockList">
315<h4>serialize</h4>
316<pre>public&nbsp;byte[]&nbsp;serialize(java.lang.String&nbsp;type,
317               java.lang.Object&nbsp;obj)
318                 throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
319<dl><dt><span class="strong">Throws:</span></dt>
320<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
321</li>
322</ul>
323<a name="serialize(java.lang.Object)">
324<!--   -->
325</a>
326<ul class="blockList">
327<li class="blockList">
328<h4>serialize</h4>
329<pre>public&nbsp;byte[]&nbsp;serialize(java.lang.Object&nbsp;obj)
330                 throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
331<dl><dt><span class="strong">Throws:</span></dt>
332<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
333</li>
334</ul>
335<a name="deserializeRequest(java.lang.String, byte[], omq.server.RemoteObject)">
336<!--   -->
337</a>
338<ul class="blockList">
339<li class="blockList">
340<h4>deserializeRequest</h4>
341<pre>public&nbsp;<a href="../../../omq/common/message/Request.html" title="class in omq.common.message">Request</a>&nbsp;deserializeRequest(java.lang.String&nbsp;type,
342                         byte[]&nbsp;bytes,
343                         <a href="../../../omq/server/RemoteObject.html" title="class in omq.server">RemoteObject</a>&nbsp;obj)
344                           throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
345<dl><dt><span class="strong">Throws:</span></dt>
346<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
347</li>
348</ul>
349<a name="deserializeResponse(byte[], java.lang.Class)">
350<!--   -->
351</a>
352<ul class="blockListLast">
353<li class="blockList">
354<h4>deserializeResponse</h4>
355<pre>public&nbsp;<a href="../../../omq/common/message/Response.html" title="class in omq.common.message">Response</a>&nbsp;deserializeResponse(byte[]&nbsp;bytes,
356                           java.lang.Class&lt;?&gt;&nbsp;type)
357                             throws <a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></pre>
358<dl><dt><span class="strong">Throws:</span></dt>
359<dd><code><a href="../../../omq/exception/SerializerException.html" title="class in omq.exception">SerializerException</a></code></dd></dl>
360</li>
361</ul>
362</li>
363</ul>
364</li>
365</ul>
366</div>
367</div>
368<!-- ========= END OF CLASS DATA ========= -->
369<!-- ======= START OF BOTTOM NAVBAR ====== -->
370<div class="bottomNav"><a name="navbar_bottom">
371<!--   -->
372</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
373<!--   -->
374</a>
375<ul class="navList" title="Navigation">
376<li><a href="../../../overview-summary.html">Overview</a></li>
377<li><a href="package-summary.html">Package</a></li>
378<li class="navBarCell1Rev">Class</li>
379<li><a href="class-use/Serializer.html">Use</a></li>
380<li><a href="package-tree.html">Tree</a></li>
381<li><a href="../../../deprecated-list.html">Deprecated</a></li>
382<li><a href="../../../index-files/index-1.html">Index</a></li>
383<li><a href="../../../help-doc.html">Help</a></li>
384</ul>
385</div>
386<div class="subNav">
387<ul class="navList">
388<li><a href="../../../omq/common/util/ParameterQueue.html" title="class in omq.common.util"><span class="strong">Prev Class</span></a></li>
389<li><a href="../../../omq/common/util/Zipper.html" title="class in omq.common.util"><span class="strong">Next Class</span></a></li>
390</ul>
391<ul class="navList">
392<li><a href="../../../index.html?omq/common/util/Serializer.html" target="_top">Frames</a></li>
393<li><a href="Serializer.html" target="_top">No Frames</a></li>
394</ul>
395<ul class="navList" id="allclasses_navbar_bottom">
396<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
397</ul>
398<div>
399<script type="text/javascript"><!--
400  allClassesLink = document.getElementById("allclasses_navbar_bottom");
401  if(window==top) {
402    allClassesLink.style.display = "block";
403  }
404  else {
405    allClassesLink.style.display = "none";
406  }
407  //-->
408</script>
409</div>
410<div>
411<ul class="subNavList">
412<li>Summary:&nbsp;</li>
413<li>Nested&nbsp;|&nbsp;</li>
414<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
415<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
416<li><a href="#method_summary">Method</a></li>
417</ul>
418<ul class="subNavList">
419<li>Detail:&nbsp;</li>
420<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
421<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
422<li><a href="#method_detail">Method</a></li>
423</ul>
424</div>
425<a name="skip-navbar_bottom">
426<!--   -->
427</a></div>
428<!-- ======== END OF BOTTOM NAVBAR ======= -->
429</body>
430</html>
Note: See TracBrowser for help on using the repository browser.