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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
|
<!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_25) on Tue Dec 03 13:53:43 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DataEncoder (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<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="DataEncoder (Carbonado 1.2.3 API)";
}
//-->
</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="class-use/DataEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/DataEncoder.html" target="_top">Frames</a></li>
<li><a href="DataEncoder.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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">com.amazon.carbonado.raw</div>
<h2 title="Class DataEncoder" class="title">Class DataEncoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.raw.DataEncoder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DataEncoder</span>
extends java.lang.Object</pre>
<div class="block">A very low-level class that supports encoding of primitive data. For
encoding data into keys, see <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw"><code>DataDecoder</code></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"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#DataEncoder()">DataEncoder</a></strong>()</code> </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"> </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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength</a></strong>(java.math.BigDecimal value)</code>
<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength</a></strong>(java.math.BigInteger value)</code>
<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength</a></strong>(byte[] value)</code>
<div class="block">Returns the amount of bytes required to encode the given byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength</a></strong>(byte[] value,
int valueOffset,
int valueLength)</code>
<div class="block">Returns the amount of bytes required to encode the given byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength</a></strong>(java.lang.String value)</code>
<div class="block">Returns the amount of bytes required to encode the given String.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode</a></strong>(java.math.BigDecimal value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given optional BigDecimal into a variable amount of
bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigInteger, byte[], int)">encode</a></strong>(java.math.BigInteger value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given optional BigInteger into a variable amount of
bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(boolean, byte[], int)">encode</a></strong>(boolean value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given boolean into exactly 1 byte.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Boolean, byte[], int)">encode</a></strong>(java.lang.Boolean value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given Boolean object into exactly 1 byte.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], byte[], int)">encode</a></strong>(byte[] value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given optional byte array into a variable amount of
bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], int, int, byte[], int)">encode</a></strong>(byte[] value,
int valueOffset,
int valueLength,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given optional byte array into a variable amount of
bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte, byte[], int)">encode</a></strong>(byte value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed byte into exactly 1 byte.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Byte, byte[], int)">encode</a></strong>(java.lang.Byte value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Character, byte[], int)">encode</a></strong>(java.lang.Character value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given Character object into exactly 1 or 3 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(char, byte[], int)">encode</a></strong>(char value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given character into exactly 2 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(double, byte[], int)">encode</a></strong>(double value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given double into exactly 8 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Double, byte[], int)">encode</a></strong>(java.lang.Double value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given Double object into exactly 8 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(float, byte[], int)">encode</a></strong>(float value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given float into exactly 4 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Float, byte[], int)">encode</a></strong>(java.lang.Float value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given Float object into exactly 4 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(int, byte[], int)">encode</a></strong>(int value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed integer into exactly 4 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Integer, byte[], int)">encode</a></strong>(java.lang.Integer value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(long, byte[], int)">encode</a></strong>(long value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed long into exactly 8 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Long, byte[], int)">encode</a></strong>(java.lang.Long value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(short, byte[], int)">encode</a></strong>(short value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed short into exactly 2 bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Short, byte[], int)">encode</a></strong>(java.lang.Short value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.String, byte[], int)">encode</a></strong>(java.lang.String value,
byte[] dst,
int dstOffset)</code>
<div class="block">Encodes the given optional String into a variable amount of bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)">encodeSingle</a></strong>(byte[] value,
int prefixPadding,
int suffixPadding)</code>
<div class="block">Encodes the given byte array for use when there is only a single
property, whose type is a byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])">encodeSingleNullable</a></strong>(byte[] value)</code>
<div class="block">Encodes the given byte array for use when there is only a single
nullable property, whose type is a byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[], int, int)">encodeSingleNullable</a></strong>(byte[] value,
int prefixPadding,
int suffixPadding)</code>
<div class="block">Encodes the given byte array for use when there is only a single
nullable property, whose type is a byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)">writeLength</a></strong>(int valueLength,
java.io.OutputStream out)</code>
<div class="block">Writes a positive length value in up to five bytes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="DataEncoder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataEncoder</h4>
<pre>public DataEncoder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="encode(int, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(int value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed integer into exactly 4 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Integer, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.Integer value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes. If
the Integer object is never expected to be null, consider encoding as an
int primitive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(long, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(long value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed long into exactly 8 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Long, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.Long value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes. If the
Long object is never expected to be null, consider encoding as a long
primitive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(byte, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(byte value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed byte into exactly 1 byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Byte, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.Byte value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes. If the
Byte object is never expected to be null, consider encoding as a byte
primitive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(short, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(short value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed short into exactly 2 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Short, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.Short value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes. If the
Short object is never expected to be null, consider encoding as a short
primitive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(char, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(char value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given character into exactly 2 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Character, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.Character value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given Character object into exactly 1 or 3 bytes. If the
Character object is never expected to be null, consider encoding as a
char primitive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(boolean, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(boolean value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given boolean into exactly 1 byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Boolean, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(java.lang.Boolean value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given Boolean object into exactly 1 byte.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(float, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(float value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given float into exactly 4 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Float, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(java.lang.Float value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given Float object into exactly 4 bytes. A non-canonical NaN
value is used to represent null.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(double, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(double value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given double into exactly 8 bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Double, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static void encode(java.lang.Double value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given Double object into exactly 8 bytes. A non-canonical
NaN value is used to represent null.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl>
</li>
</ul>
<a name="encode(java.math.BigInteger, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.math.BigInteger value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given optional BigInteger into a variable amount of
bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise,
the amount written can be determined by calling calculateEncodedLength.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="calculateEncodedLength(java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateEncodedLength</h4>
<pre>public static int calculateEncodedLength(java.math.BigInteger value)</pre>
<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="encode(java.math.BigDecimal, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.math.BigDecimal value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given optional BigDecimal into a variable amount of
bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise,
the amount written can be determined by calling calculateEncodedLength.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="calculateEncodedLength(java.math.BigDecimal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateEncodedLength</h4>
<pre>public static int calculateEncodedLength(java.math.BigDecimal value)</pre>
<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="encode(byte[], byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(byte[] value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given optional byte array into a variable amount of
bytes. If the byte array is null, exactly 1 byte is written. Otherwise,
the amount written can be determined by calling calculateEncodedLength.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="encode(byte[], int, int, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(byte[] value,
int valueOffset,
int valueLength,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given optional byte array into a variable amount of
bytes. If the byte array is null, exactly 1 byte is written. Otherwise,
the amount written can be determined by calling calculateEncodedLength.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="calculateEncodedLength(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateEncodedLength</h4>
<pre>public static int calculateEncodedLength(byte[] value)</pre>
<div class="block">Returns the amount of bytes required to encode the given byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl>
</li>
</ul>
<a name="calculateEncodedLength(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateEncodedLength</h4>
<pre>public static int calculateEncodedLength(byte[] value,
int valueOffset,
int valueLength)</pre>
<div class="block">Returns the amount of bytes required to encode the given byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl>
</li>
</ul>
<a name="encode(java.lang.String, byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public static int encode(java.lang.String value,
byte[] dst,
int dstOffset)</pre>
<div class="block">Encodes the given optional String into a variable amount of bytes. The
amount written can be determined by calling
calculateEncodedStringLength.
<p>
Strings are encoded in a fashion similar to UTF-8, in that ASCII
characters are written in one byte. This encoding is more efficient than
UTF-8, but it isn't compatible with UTF-8.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd>
<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl>
</li>
</ul>
<a name="calculateEncodedStringLength(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateEncodedStringLength</h4>
<pre>public static int calculateEncodedStringLength(java.lang.String value)</pre>
<div class="block">Returns the amount of bytes required to encode the given String.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String to encode, may be null</dd></dl>
</li>
</ul>
<a name="writeLength(int, java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeLength</h4>
<pre>public static int writeLength(int valueLength,
java.io.OutputStream out)
throws java.io.IOException</pre>
<div class="block">Writes a positive length value in up to five bytes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of bytes written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="encodeSingle(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeSingle</h4>
<pre>public static byte[] encodeSingle(byte[] value,
int prefixPadding,
int suffixPadding)</pre>
<div class="block">Encodes the given byte array for use when there is only a single
property, whose type is a byte array. The original byte array is
returned if the padding lengths are zero.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</dd></dl>
</li>
</ul>
<a name="encodeSingleNullable(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeSingleNullable</h4>
<pre>public static byte[] encodeSingleNullable(byte[] value)</pre>
<div class="block">Encodes the given byte array for use when there is only a single
nullable property, whose type is a byte array.</div>
</li>
</ul>
<a name="encodeSingleNullable(byte[], int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>encodeSingleNullable</h4>
<pre>public static byte[] encodeSingleNullable(byte[] value,
int prefixPadding,
int suffixPadding)</pre>
<div class="block">Encodes the given byte array for use when there is only a single
nullable property, whose type is a byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</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="class-use/DataEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/DataEncoder.html" target="_top">Frames</a></li>
<li><a href="DataEncoder.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
