forked from detro/Java-WebSocket
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBase64.html
More file actions
1340 lines (1226 loc) · 56.7 KB
/
Base64.html
File metadata and controls
1340 lines (1226 loc) · 56.7 KB
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
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Wed Mar 21 10:38:03 GMT 2012 -->
<TITLE>
Base64
</TITLE>
<META NAME="date" CONTENT="2012-03-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Base64";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../org/java_websocket/util/Base64.InputStream.html" title="class in org.java_websocket.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/java_websocket/util/Base64.html" target="_top"><B>FRAMES</B></A>
<A HREF="Base64.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.java_websocket.util</FONT>
<BR>
Class Base64</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.java_websocket.util.Base64</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Base64</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
<p>Encodes and decodes to and from Base64 notation.</p>
<p>Homepage: <a href="http://iharder.net/base64">http://iharder.net/base64</a>.</p>
<p>Example:</p>
<code>String encoded = Base64.encode( myByteArray );</code>
<br />
<code>byte[] myByteArray = Base64.decode( encoded );</code>
<p>The <tt>options</tt> parameter, which appears in a few places, is used to pass
several pieces of information to the encoder. In the "higher level" methods such as
encodeBytes( bytes, options ) the options parameter can be used to indicate such
things as first gzipping the bytes before encoding them, not inserting linefeeds,
and encoding using the URL-safe and Ordered dialects.</p>
<p>Note, according to <a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>,
Section 2.1, implementations should not add line feeds unless explicitly told
to do so. I've got Base64 set to this behavior now, although earlier versions
broke lines by default.</p>
<p>The constants defined in Base64 can be OR-ed together to combine options, so you
might make a call like this:</p>
<code>String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES );</code>
<p>to compress the data before encoding it and then making the output have newline characters.</p>
<p>Also...</p>
<code>String encoded = Base64.encodeBytes( crazyString.getBytes() );</code>
<p>
Change Log:
</p>
<ul>
<li>v2.3.7 - Fixed subtle bug when base 64 input stream contained the
value 01111111, which is an invalid base 64 character but should not
throw an ArrayIndexOutOfBoundsException either. Led to discovery of
mishandling (or potential for better handling) of other bad input
characters. You should now get an IOException if you try decoding
something that has bad characters in it.</li>
<li>v2.3.6 - Fixed bug when breaking lines and the final byte of the encoded
string ended in the last column; the buffer was not properly shrunk and
contained an extra (null) byte that made it into the string.</li>
<li>v2.3.5 - Fixed bug in <A HREF="../../../org/java_websocket/util/Base64.html#encodeFromFile(java.lang.String)"><CODE>encodeFromFile(java.lang.String)</CODE></A> where estimated buffer size
was wrong for files of size 31, 34, and 37 bytes.</li>
<li>v2.3.4 - Fixed bug when working with gzipped streams whereby flushing
the Base64.OutputStream closed the Base64 encoding (by padding with equals
signs) too soon. Also added an option to suppress the automatic decoding
of gzipped streams. Also added experimental support for specifying a
class loader when using the
<A HREF="../../../org/java_websocket/util/Base64.html#decodeToObject(java.lang.String, int, java.lang.ClassLoader)"><CODE>decodeToObject(java.lang.String, int, java.lang.ClassLoader)</CODE></A>
method.</li>
<li>v2.3.3 - Changed default char encoding to US-ASCII which reduces the internal Java
footprint with its CharEncoders and so forth. Fixed some javadocs that were
inconsistent. Removed imports and specified things like java.io.IOException
explicitly inline.</li>
<li>v2.3.2 - Reduced memory footprint! Finally refined the "guessing" of how big the
final encoded data will be so that the code doesn't have to create two output
arrays: an oversized initial one and then a final, exact-sized one. Big win
when using the <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytesToBytes(byte[])"><CODE>encodeBytesToBytes(byte[])</CODE></A> family of methods (and not
using the gzip options which uses a different mechanism with streams and stuff).</li>
<li>v2.3.1 - Added <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytesToBytes(byte[], int, int, int)"><CODE>encodeBytesToBytes(byte[], int, int, int)</CODE></A> and some
similar helper methods to be more efficient with memory by not returning a
String but just a byte array.</li>
<li>v2.3 - <strong>This is not a drop-in replacement!</strong> This is two years of comments
and bug fixes queued up and finally executed. Thanks to everyone who sent
me stuff, and I'm sorry I wasn't able to distribute your fixes to everyone else.
Much bad coding was cleaned up including throwing exceptions where necessary
instead of returning null values or something similar. Here are some changes
that may affect you:
<ul>
<li><em>Does not break lines, by default.</em> This is to keep in compliance with
<a href="http://www.faqs.org/rfcs/rfc3548.html">RFC3548</a>.</li>
<li><em>Throws exceptions instead of returning null values.</em> Because some operations
(especially those that may permit the GZIP option) use IO streams, there
is a possiblity of an java.io.IOException being thrown. After some discussion and
thought, I've changed the behavior of the methods to throw java.io.IOExceptions
rather than return null if ever there's an error. I think this is more
appropriate, though it will require some changes to your code. Sorry,
it should have been done this way to begin with.</li>
<li><em>Removed all references to System.out, System.err, and the like.</em>
Shame on me. All I can say is sorry they were ever there.</li>
<li><em>Throws NullPointerExceptions and IllegalArgumentExceptions</em> as needed
such as when passed arrays are null or offsets are invalid.</li>
<li>Cleaned up as much javadoc as I could to avoid any javadoc warnings.
This was especially annoying before for people who were thorough in their
own projects and then had gobs of javadoc warnings on this file.</li>
</ul>
<li>v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug
when using very small files (~< 40 bytes).</li>
<li>v2.2 - Added some helper methods for encoding/decoding directly from
one file to the next. Also added a main() method to support command line
encoding/decoding from one file to the next. Also added these Base64 dialects:
<ol>
<li>The default is RFC3548 format.</li>
<li>Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates
URL and file name friendly format as described in Section 4 of RFC3548.
http://www.faqs.org/rfcs/rfc3548.html</li>
<li>Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates
URL and file name friendly format that preserves lexical ordering as described
in http://www.faqs.org/qa/rfcc-1940.html</li>
</ol>
Special thanks to Jim Kellerman at <a href="http://www.powerset.com/">http://www.powerset.com/</a>
for contributing the new Base64 dialects.
</li>
<li>v2.1 - Cleaned up javadoc comments and unused variables and methods. Added
some convenience methods for reading and writing to and from files.</li>
<li>v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems
with other encodings (like EBCDIC).</li>
<li>v2.0.1 - Fixed an error when decoding a single byte, that is, when the
encoded data was a single byte.</li>
<li>v2.0 - I got rid of methods that used booleans to set options.
Now everything is more consolidated and cleaner. The code now detects
when data that's being decoded is gzip-compressed and will decompress it
automatically. Generally things are cleaner. You'll probably have to
change some method calls that you were making to support the new
options format (<tt>int</tt>s that you "OR" together).</li>
<li>v1.5.1 - Fixed bug when decompressing and decoding to a
byte[] using <tt>decode( String s, boolean gzipCompressed )</tt>.
Added the ability to "suspend" encoding in the Output Stream so
you can turn on and off the encoding if you need to embed base64
data in an otherwise "normal" stream (like an XML file).</li>
<li>v1.5 - Output stream pases on flush() command but doesn't do anything itself.
This helps when using GZIP streams.
Added the ability to GZip-compress objects before encoding them.</li>
<li>v1.4 - Added helper methods to read/write files.</li>
<li>v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.</li>
<li>v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream
where last buffer being read, if not completely full, was not returned.</li>
<li>v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.</li>
<li>v1.3.3 - Fixed I/O streams which were totally messed up.</li>
</ul>
<p>
I am placing this code in the Public Domain. Do with it as you will.
This software comes with no guarantees or warranties but with
plenty of well-wishing instead!
Please visit <a href="http://iharder.net/base64">http://iharder.net/base64</a>
periodically to check for updates or to contribute improvements.
</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>2.3.7</DD>
<DT><B>Author:</B></DT>
<DD>Robert Harder, rob@iharder.net</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.InputStream.html" title="class in org.java_websocket.util">Base64.InputStream</A></B></CODE>
<BR>
A <A HREF="../../../org/java_websocket/util/Base64.InputStream.html" title="class in org.java_websocket.util"><CODE>Base64.InputStream</CODE></A> will read data from another
<tt>java.io.InputStream</tt>, given in the constructor,
and encode/decode to/from Base64 notation on the fly.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.OutputStream.html" title="class in org.java_websocket.util">Base64.OutputStream</A></B></CODE>
<BR>
A <A HREF="../../../org/java_websocket/util/Base64.OutputStream.html" title="class in org.java_websocket.util"><CODE>Base64.OutputStream</CODE></A> will write data to another
<tt>java.io.OutputStream</tt>, given in the constructor,
and encode/decode to/from Base64 notation on the fly.</TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#DECODE">DECODE</A></B></CODE>
<BR>
Specify decoding in first bit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES">DO_BREAK_LINES</A></B></CODE>
<BR>
Do break lines when encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#DONT_GUNZIP">DONT_GUNZIP</A></B></CODE>
<BR>
Specify that gzipped data should <em>not</em> be automatically gunzipped.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#ENCODE">ENCODE</A></B></CODE>
<BR>
Specify encoding in first bit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#GZIP">GZIP</A></B></CODE>
<BR>
Specify that data should be gzip-compressed in second bit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#NO_OPTIONS">NO_OPTIONS</A></B></CODE>
<BR>
No options specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#ORDERED">ORDERED</A></B></CODE>
<BR>
Encode using the special "ordered" dialect of Base64 described here:
<a href="http://www.faqs.org/qa/rfcc-1940.html">http://www.faqs.org/qa/rfcc-1940.html</a>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#URL_SAFE">URL_SAFE</A></B></CODE>
<BR>
Encode using Base64-like encoding that is URL- and Filename-safe as described
in Section 4 of RFC3548:
<a href="http://www.faqs.org/rfcs/rfc3548.html">http://www.faqs.org/rfcs/rfc3548.html</a>.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decode(byte[])">decode</A></B>(byte[] source)</CODE>
<BR>
Low-level access to decoding ASCII characters in
the form of a byte array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decode(byte[], int, int, int)">decode</A></B>(byte[] source,
int off,
int len,
int options)</CODE>
<BR>
Low-level access to decoding ASCII characters in
the form of a byte array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decode(java.lang.String)">decode</A></B>(java.lang.String s)</CODE>
<BR>
Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decode(java.lang.String, int)">decode</A></B>(java.lang.String s,
int options)</CODE>
<BR>
Decodes data from Base64 notation, automatically
detecting gzip-compressed data and decompressing it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decodeFileToFile(java.lang.String, java.lang.String)">decodeFileToFile</A></B>(java.lang.String infile,
java.lang.String outfile)</CODE>
<BR>
Reads <tt>infile</tt> and decodes it to <tt>outfile</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decodeFromFile(java.lang.String)">decodeFromFile</A></B>(java.lang.String filename)</CODE>
<BR>
Convenience method for reading a base64-encoded
file and decoding it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decodeToFile(java.lang.String, java.lang.String)">decodeToFile</A></B>(java.lang.String dataToDecode,
java.lang.String filename)</CODE>
<BR>
Convenience method for decoding data to a file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decodeToObject(java.lang.String)">decodeToObject</A></B>(java.lang.String encodedObject)</CODE>
<BR>
Attempts to decode Base64 data and deserialize a Java
Object within.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#decodeToObject(java.lang.String, int, java.lang.ClassLoader)">decodeToObject</A></B>(java.lang.String encodedObject,
int options,
java.lang.ClassLoader loader)</CODE>
<BR>
Attempts to decode Base64 data and deserialize a Java
Object within.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encode(java.nio.ByteBuffer, java.nio.ByteBuffer)">encode</A></B>(java.nio.ByteBuffer raw,
java.nio.ByteBuffer encoded)</CODE>
<BR>
Performs Base64 encoding on the <code>raw</code> ByteBuffer,
writing it to the <code>encoded</code> ByteBuffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encode(java.nio.ByteBuffer, java.nio.CharBuffer)">encode</A></B>(java.nio.ByteBuffer raw,
java.nio.CharBuffer encoded)</CODE>
<BR>
Performs Base64 encoding on the <code>raw</code> ByteBuffer,
writing it to the <code>encoded</code> CharBuffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[])">encodeBytes</A></B>(byte[] source)</CODE>
<BR>
Encodes a byte array into Base64 notation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[], int)">encodeBytes</A></B>(byte[] source,
int options)</CODE>
<BR>
Encodes a byte array into Base64 notation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[], int, int)">encodeBytes</A></B>(byte[] source,
int off,
int len)</CODE>
<BR>
Encodes a byte array into Base64 notation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[], int, int, int)">encodeBytes</A></B>(byte[] source,
int off,
int len,
int options)</CODE>
<BR>
Encodes a byte array into Base64 notation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytesToBytes(byte[])">encodeBytesToBytes</A></B>(byte[] source)</CODE>
<BR>
Similar to <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[])"><CODE>encodeBytes(byte[])</CODE></A> but returns
a byte array instead of instantiating a String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeBytesToBytes(byte[], int, int, int)">encodeBytesToBytes</A></B>(byte[] source,
int off,
int len,
int options)</CODE>
<BR>
Similar to <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[], int, int, int)"><CODE>encodeBytes(byte[], int, int, int)</CODE></A> but returns
a byte array instead of instantiating a String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeFileToFile(java.lang.String, java.lang.String)">encodeFileToFile</A></B>(java.lang.String infile,
java.lang.String outfile)</CODE>
<BR>
Reads <tt>infile</tt> and encodes it to <tt>outfile</tt>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeFromFile(java.lang.String)">encodeFromFile</A></B>(java.lang.String filename)</CODE>
<BR>
Convenience method for reading a binary file
and base64-encoding it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeObject(java.io.Serializable)">encodeObject</A></B>(java.io.Serializable serializableObject)</CODE>
<BR>
Serializes an object and returns the Base64-encoded
version of that serialized object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeObject(java.io.Serializable, int)">encodeObject</A></B>(java.io.Serializable serializableObject,
int options)</CODE>
<BR>
Serializes an object and returns the Base64-encoded
version of that serialized object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/java_websocket/util/Base64.html#encodeToFile(byte[], java.lang.String)">encodeToFile</A></B>(byte[] dataToEncode,
java.lang.String filename)</CODE>
<BR>
Convenience method for encoding data to a file.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="NO_OPTIONS"><!-- --></A><H3>
NO_OPTIONS</H3>
<PRE>
public static final int <B>NO_OPTIONS</B></PRE>
<DL>
<DD>No options specified. Value is zero.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.NO_OPTIONS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ENCODE"><!-- --></A><H3>
ENCODE</H3>
<PRE>
public static final int <B>ENCODE</B></PRE>
<DL>
<DD>Specify encoding in first bit. Value is one.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.ENCODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DECODE"><!-- --></A><H3>
DECODE</H3>
<PRE>
public static final int <B>DECODE</B></PRE>
<DL>
<DD>Specify decoding in first bit. Value is zero.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.DECODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="GZIP"><!-- --></A><H3>
GZIP</H3>
<PRE>
public static final int <B>GZIP</B></PRE>
<DL>
<DD>Specify that data should be gzip-compressed in second bit. Value is two.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.GZIP">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DONT_GUNZIP"><!-- --></A><H3>
DONT_GUNZIP</H3>
<PRE>
public static final int <B>DONT_GUNZIP</B></PRE>
<DL>
<DD>Specify that gzipped data should <em>not</em> be automatically gunzipped.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.DONT_GUNZIP">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DO_BREAK_LINES"><!-- --></A><H3>
DO_BREAK_LINES</H3>
<PRE>
public static final int <B>DO_BREAK_LINES</B></PRE>
<DL>
<DD>Do break lines when encoding. Value is 8.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.DO_BREAK_LINES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="URL_SAFE"><!-- --></A><H3>
URL_SAFE</H3>
<PRE>
public static final int <B>URL_SAFE</B></PRE>
<DL>
<DD>Encode using Base64-like encoding that is URL- and Filename-safe as described
in Section 4 of RFC3548:
<a href="http://www.faqs.org/rfcs/rfc3548.html">http://www.faqs.org/rfcs/rfc3548.html</a>.
It is important to note that data encoded this way is <em>not</em> officially valid Base64,
or at the very least should not be called Base64 without also specifying that is
was encoded using the URL- and Filename-safe dialect.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.URL_SAFE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ORDERED"><!-- --></A><H3>
ORDERED</H3>
<PRE>
public static final int <B>ORDERED</B></PRE>
<DL>
<DD>Encode using the special "ordered" dialect of Base64 described here:
<a href="http://www.faqs.org/qa/rfcc-1940.html">http://www.faqs.org/qa/rfcc-1940.html</a>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.java_websocket.util.Base64.ORDERED">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="encode(java.nio.ByteBuffer, java.nio.ByteBuffer)"><!-- --></A><H3>
encode</H3>
<PRE>
public static void <B>encode</B>(java.nio.ByteBuffer raw,
java.nio.ByteBuffer encoded)</PRE>
<DL>
<DD>Performs Base64 encoding on the <code>raw</code> ByteBuffer,
writing it to the <code>encoded</code> ByteBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as <A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A>
or <A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>raw</CODE> - input buffer<DD><CODE>encoded</CODE> - output buffer<DT><B>Since:</B></DT>
<DD>2.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encode(java.nio.ByteBuffer, java.nio.CharBuffer)"><!-- --></A><H3>
encode</H3>
<PRE>
public static void <B>encode</B>(java.nio.ByteBuffer raw,
java.nio.CharBuffer encoded)</PRE>
<DL>
<DD>Performs Base64 encoding on the <code>raw</code> ByteBuffer,
writing it to the <code>encoded</code> CharBuffer.
This is an experimental feature. Currently it does not
pass along any options (such as <A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A>
or <A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>raw</CODE> - input buffer<DD><CODE>encoded</CODE> - output buffer<DT><B>Since:</B></DT>
<DD>2.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encodeObject(java.io.Serializable)"><!-- --></A><H3>
encodeObject</H3>
<PRE>
public static java.lang.String <B>encodeObject</B>(java.io.Serializable serializableObject)
throws java.io.IOException</PRE>
<DL>
<DD>Serializes an object and returns the Base64-encoded
version of that serialized object.
<p>As of v 2.3, if the object
cannot be serialized or there is another error,
the method will throw an java.io.IOException. <b>This is new to v2.3!</b>
In earlier versions, it just returned a null value, but
in retrospect that's a pretty poor way to handle it.</p>
The object is not GZip-compressed before being encoded.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serializableObject</CODE> - The object to encode
<DT><B>Returns:</B><DD>The Base64-encoded object
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if there is an error
<DD><CODE>java.lang.NullPointerException</CODE> - if serializedObject is null<DT><B>Since:</B></DT>
<DD>1.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encodeObject(java.io.Serializable, int)"><!-- --></A><H3>
encodeObject</H3>
<PRE>
public static java.lang.String <B>encodeObject</B>(java.io.Serializable serializableObject,
int options)
throws java.io.IOException</PRE>
<DL>
<DD>Serializes an object and returns the Base64-encoded
version of that serialized object.
<p>As of v 2.3, if the object
cannot be serialized or there is another error,
the method will throw an java.io.IOException. <b>This is new to v2.3!</b>
In earlier versions, it just returned a null value, but
in retrospect that's a pretty poor way to handle it.</p>
The object is not GZip-compressed before being encoded.
<p>
Example options:<pre>
GZIP: gzip-compresses object before encoding it.
DO_BREAK_LINES: break lines at 76 characters
</pre>
<p>
Example: <code>encodeObject( myObj, Base64.GZIP )</code> or
<p>
Example: <code>encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES )</code>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serializableObject</CODE> - The object to encode<DD><CODE>options</CODE> - Specified options
<DT><B>Returns:</B><DD>The Base64-encoded object
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if there is an error<DT><B>Since:</B></DT>
<DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>,
<A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytes(byte[])"><!-- --></A><H3>
encodeBytes</H3>
<PRE>
public static java.lang.String <B>encodeBytes</B>(byte[] source)</PRE>
<DL>
<DD>Encodes a byte array into Base64 notation.
Does not GZip-compress data.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert
<DT><B>Returns:</B><DD>The data in Base64-encoded form
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null<DT><B>Since:</B></DT>
<DD>1.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytes(byte[], int)"><!-- --></A><H3>
encodeBytes</H3>
<PRE>
public static java.lang.String <B>encodeBytes</B>(byte[] source,
int options)
throws java.io.IOException</PRE>
<DL>
<DD>Encodes a byte array into Base64 notation.
<p>
Example options:<pre>
GZIP: gzip-compresses object before encoding it.
DO_BREAK_LINES: break lines at 76 characters
<i>Note: Technically, this makes your encoding non-compliant.</i>
</pre>
<p>
Example: <code>encodeBytes( myData, Base64.GZIP )</code> or
<p>
Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )</code>
<p>As of v 2.3, if there is an error with the GZIP stream,
the method will throw an java.io.IOException. <b>This is new to v2.3!</b>
In earlier versions, it just returned a null value, but
in retrospect that's a pretty poor way to handle it.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert<DD><CODE>options</CODE> - Specified options
<DT><B>Returns:</B><DD>The Base64-encoded data as a String
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if there is an error
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null<DT><B>Since:</B></DT>
<DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>,
<A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytes(byte[], int, int)"><!-- --></A><H3>
encodeBytes</H3>
<PRE>
public static java.lang.String <B>encodeBytes</B>(byte[] source,
int off,
int len)</PRE>
<DL>
<DD>Encodes a byte array into Base64 notation.
Does not GZip-compress data.
<p>As of v 2.3, if there is an error,
the method will throw an java.io.IOException. <b>This is new to v2.3!</b>
In earlier versions, it just returned a null value, but
in retrospect that's a pretty poor way to handle it.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert<DD><CODE>off</CODE> - Offset in array where conversion should begin<DD><CODE>len</CODE> - Length of data to convert
<DT><B>Returns:</B><DD>The Base64-encoded data as a String
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if source array, offset, or length are invalid<DT><B>Since:</B></DT>
<DD>1.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytes(byte[], int, int, int)"><!-- --></A><H3>
encodeBytes</H3>
<PRE>
public static java.lang.String <B>encodeBytes</B>(byte[] source,
int off,
int len,
int options)
throws java.io.IOException</PRE>
<DL>
<DD>Encodes a byte array into Base64 notation.
<p>
Example options:<pre>
GZIP: gzip-compresses object before encoding it.
DO_BREAK_LINES: break lines at 76 characters
<i>Note: Technically, this makes your encoding non-compliant.</i>
</pre>
<p>
Example: <code>encodeBytes( myData, Base64.GZIP )</code> or
<p>
Example: <code>encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES )</code>
<p>As of v 2.3, if there is an error with the GZIP stream,
the method will throw an java.io.IOException. <b>This is new to v2.3!</b>
In earlier versions, it just returned a null value, but
in retrospect that's a pretty poor way to handle it.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert<DD><CODE>off</CODE> - Offset in array where conversion should begin<DD><CODE>len</CODE> - Length of data to convert<DD><CODE>options</CODE> - Specified options
<DT><B>Returns:</B><DD>The Base64-encoded data as a String
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if there is an error
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if source array, offset, or length are invalid<DT><B>Since:</B></DT>
<DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>,
<A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytesToBytes(byte[])"><!-- --></A><H3>
encodeBytesToBytes</H3>
<PRE>
public static byte[] <B>encodeBytesToBytes</B>(byte[] source)</PRE>
<DL>
<DD>Similar to <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[])"><CODE>encodeBytes(byte[])</CODE></A> but returns
a byte array instead of instantiating a String. This is more efficient
if you're working with I/O streams and have large data sets to encode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert
<DT><B>Returns:</B><DD>The Base64-encoded data as a byte[] (of ASCII characters)
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null<DT><B>Since:</B></DT>
<DD>2.3.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="encodeBytesToBytes(byte[], int, int, int)"><!-- --></A><H3>
encodeBytesToBytes</H3>
<PRE>
public static byte[] <B>encodeBytesToBytes</B>(byte[] source,
int off,
int len,
int options)
throws java.io.IOException</PRE>
<DL>
<DD>Similar to <A HREF="../../../org/java_websocket/util/Base64.html#encodeBytes(byte[], int, int, int)"><CODE>encodeBytes(byte[], int, int, int)</CODE></A> but returns
a byte array instead of instantiating a String. This is more efficient
if you're working with I/O streams and have large data sets to encode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The data to convert<DD><CODE>off</CODE> - Offset in array where conversion should begin<DD><CODE>len</CODE> - Length of data to convert<DD><CODE>options</CODE> - Specified options
<DT><B>Returns:</B><DD>The Base64-encoded data as a String
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if there is an error
<DD><CODE>java.lang.NullPointerException</CODE> - if source array is null
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if source array, offset, or length are invalid<DT><B>Since:</B></DT>
<DD>2.3.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../org/java_websocket/util/Base64.html#GZIP"><CODE>GZIP</CODE></A>,
<A HREF="../../../org/java_websocket/util/Base64.html#DO_BREAK_LINES"><CODE>DO_BREAK_LINES</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="decode(byte[])"><!-- --></A><H3>
decode</H3>
<PRE>
public static byte[] <B>decode</B>(byte[] source)
throws java.io.IOException</PRE>