summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/serializer/KryoSerializer.html
blob: 9ad28f58e0fe17a86dd3da1fcc7b4bfd6ae42c94 (plain) (tree) 
443d7fc27 ^




10bf7477e ^

443d7fc27 ^

10bf7477e ^

443d7fc27 ^































10bf7477e ^

443d7fc27 ^









































































































































































































































































































10bf7477e ^

443d7fc27 ^









































1
2
3
4

5

6

7

8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

337

338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378




                                                                                                      
                                                                                
                             
                                       






























                                                                                                                                                                           
                                                                                                                                                                           








































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                           








































                                                                                                                                                                                         
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Sep 16 10:26:31 PDT 2015 -->
<title>KryoSerializer</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="KryoSerializer";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/spark/serializer/KryoRegistrator.html" title="interface in org.apache.spark.serializer"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/serializer/SerializationStream.html" title="class in org.apache.spark.serializer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/serializer/KryoSerializer.html" target="_top">Frames</a></li>
<li><a href="KryoSerializer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.serializer</div>
<h2 title="Class KryoSerializer" class="title">Class KryoSerializer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/spark/serializer/Serializer.html" title="class in org.apache.spark.serializer">org.apache.spark.serializer.Serializer</a></li>
<li>
<ul class="inheritance">
<li>org.apache.spark.serializer.KryoSerializer</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">KryoSerializer</span>
extends <a href="../../../../org/apache/spark/serializer/Serializer.html" title="class in org.apache.spark.serializer">Serializer</a>
implements <a href="../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, scala.Serializable</pre>
<div class="block">A Spark serializer that uses the <code>Kryo serialization library</code>.
 <p>
 Note that this serializer is not guaranteed to be wire-compatible across different versions of
 Spark. It is intended to be used to serialize/de-serialize data within a single
 Spark application.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.spark.serializer.KryoSerializer">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#KryoSerializer(org.apache.spark.SparkConf)">KryoSerializer</a></strong>(<a href="../../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a>&nbsp;conf)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#maxBufferSizeMb()">maxBufferSizeMb</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/spark/serializer/SerializerInstance.html" title="class in org.apache.spark.serializer">SerializerInstance</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#newInstance()">newInstance</a></strong>()</code>
<div class="block">Creates a new <a href="../../../../org/apache/spark/serializer/SerializerInstance.html" title="class in org.apache.spark.serializer"><code>SerializerInstance</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.esotericsoftware.kryo.Kryo</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#newKryo()">newKryo</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.esotericsoftware.kryo.io.Output</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#newKryoOutput()">newKryoOutput</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/serializer/KryoSerializer.html#supportsRelocationOfSerializedObjects()">supportsRelocationOfSerializedObjects</a></strong>()</code>
<div class="block">:: Private ::
 Returns true if this serializer supports relocation of its serialized objects and false
 otherwise.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.serializer.Serializer">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.serializer.<a href="../../../../org/apache/spark/serializer/Serializer.html" title="class in org.apache.spark.serializer">Serializer</a></h3>
<code><a href="../../../../org/apache/spark/serializer/Serializer.html#defaultClassLoader()">defaultClassLoader</a>, <a href="../../../../org/apache/spark/serializer/Serializer.html#getSerializer(scala.Option)">getSerializer</a>, <a href="../../../../org/apache/spark/serializer/Serializer.html#getSerializer(org.apache.spark.serializer.Serializer)">getSerializer</a>, <a href="../../../../org/apache/spark/serializer/Serializer.html#setDefaultClassLoader(java.lang.ClassLoader)">setDefaultClassLoader</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.Logging">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.<a href="../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></h3>
<code><a href="../../../../org/apache/spark/Logging.html#initializeIfNecessary()">initializeIfNecessary</a>, <a href="../../../../org/apache/spark/Logging.html#initializeLogging()">initializeLogging</a>, <a href="../../../../org/apache/spark/Logging.html#isTraceEnabled()">isTraceEnabled</a>, <a href="../../../../org/apache/spark/Logging.html#log_()">log_</a>, <a href="../../../../org/apache/spark/Logging.html#log()">log</a>, <a href="../../../../org/apache/spark/Logging.html#logDebug(scala.Function0)">logDebug</a>, <a href="../../../../org/apache/spark/Logging.html#logDebug(scala.Function0, java.lang.Throwable)">logDebug</a>, <a href="../../../../org/apache/spark/Logging.html#logError(scala.Function0)">logError</a>, <a href="../../../../org/apache/spark/Logging.html#logError(scala.Function0, java.lang.Throwable)">logError</a>, <a href="../../../../org/apache/spark/Logging.html#logInfo(scala.Function0)">logInfo</a>, <a href="../../../../org/apache/spark/Logging.html#logInfo(scala.Function0, java.lang.Throwable)">logInfo</a>, <a href="../../../../org/apache/spark/Logging.html#logName()">logName</a>, <a href="../../../../org/apache/spark/Logging.html#logTrace(scala.Function0)">logTrace</a>, <a href="../../../../org/apache/spark/Logging.html#logTrace(scala.Function0, java.lang.Throwable)">logTrace</a>, <a href="../../../../org/apache/spark/Logging.html#logWarning(scala.Function0)">logWarning</a>, <a href="../../../../org/apache/spark/Logging.html#logWarning(scala.Function0, java.lang.Throwable)">logWarning</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="KryoSerializer(org.apache.spark.SparkConf)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KryoSerializer</h4>
<pre>public&nbsp;KryoSerializer(<a href="../../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a>&nbsp;conf)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="maxBufferSizeMb()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxBufferSizeMb</h4>
<pre>public&nbsp;int&nbsp;maxBufferSizeMb()</pre>
</li>
</ul>
<a name="newKryoOutput()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newKryoOutput</h4>
<pre>public&nbsp;com.esotericsoftware.kryo.io.Output&nbsp;newKryoOutput()</pre>
</li>
</ul>
<a name="newKryo()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newKryo</h4>
<pre>public&nbsp;com.esotericsoftware.kryo.Kryo&nbsp;newKryo()</pre>
</li>
</ul>
<a name="newInstance()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre>public&nbsp;<a href="../../../../org/apache/spark/serializer/SerializerInstance.html" title="class in org.apache.spark.serializer">SerializerInstance</a>&nbsp;newInstance()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/spark/serializer/Serializer.html#newInstance()">Serializer</a></code></strong></div>
<div class="block">Creates a new <a href="../../../../org/apache/spark/serializer/SerializerInstance.html" title="class in org.apache.spark.serializer"><code>SerializerInstance</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/spark/serializer/Serializer.html#newInstance()">newInstance</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/spark/serializer/Serializer.html" title="class in org.apache.spark.serializer">Serializer</a></code></dd>
</dl>
</li>
</ul>
<a name="supportsRelocationOfSerializedObjects()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>supportsRelocationOfSerializedObjects</h4>
<pre>public&nbsp;boolean&nbsp;supportsRelocationOfSerializedObjects()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/spark/serializer/Serializer.html#supportsRelocationOfSerializedObjects()">Serializer</a></code></strong></div>
<div class="block">:: Private ::
 Returns true if this serializer supports relocation of its serialized objects and false
 otherwise. This should return true if and only if reordering the bytes of serialized objects
 in serialization stream output is equivalent to having re-ordered those elements prior to
 serializing them. More specifically, the following should hold if a serializer supports
 relocation:
 <p>
 <pre><code>
 serOut.open()
 position = 0
 serOut.write(obj1)
 serOut.flush()
 position = # of bytes writen to stream so far
 obj1Bytes = output[0:position-1]
 serOut.write(obj2)
 serOut.flush()
 position2 = # of bytes written to stream so far
 obj2Bytes = output[position:position2-1]
 serIn.open([obj2bytes] concatenate [obj1bytes]) should return (obj2, obj1)
 </code></pre>
 <p>
 In general, this property should hold for serializers that are stateless and that do not
 write special metadata at the beginning or end of the serialization stream.
 <p>
 This API is private to Spark; this method should not be overridden in third-party subclasses
 or called in user code and is subject to removal in future Spark releases.
 <p>
 See SPARK-7311 for more details.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/spark/serializer/KryoRegistrator.html" title="interface in org.apache.spark.serializer"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/serializer/SerializationStream.html" title="class in org.apache.spark.serializer"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/serializer/KryoSerializer.html" target="_top">Frames</a></li>
<li><a href="KryoSerializer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../lib/api-javadocs.js"></script></body>
</html>
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-11 09:49:07 +0000