/usr/share/doc/libcommons-codec-java/api/org/apache/commons/codec/binary/Base32.html is in libcommons-codec-java-doc 1.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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_22) on Sat Apr 30 16:47:23 UTC 2011 -->
<TITLE>
Base32 (Encode/Decode Utilities (Version 1.5-SNAPSHOT))
</TITLE>
<META NAME="date" CONTENT="2011-04-30">
<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="Base32 (Encode/Decode Utilities (Version 1.5-SNAPSHOT))";
}
}
</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="class-use/Base32.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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/apache/commons/codec/binary/Base32InputStream.html" title="class in org.apache.commons.codec.binary"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/codec/binary/Base32.html" target="_top"><B>FRAMES</B></A>
<A HREF="Base32.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.apache.commons.codec.binary</FONT>
<BR>
Class Base32</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">org.apache.commons.codec.binary.BaseNCodec</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.codec.binary.Base32</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/codec/BinaryDecoder.html" title="interface in org.apache.commons.codec">BinaryDecoder</A>, <A HREF="../../../../../org/apache/commons/codec/BinaryEncoder.html" title="interface in org.apache.commons.codec">BinaryEncoder</A>, <A HREF="../../../../../org/apache/commons/codec/Decoder.html" title="interface in org.apache.commons.codec">Decoder</A>, <A HREF="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>Base32</B><DT>extends <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></DL>
</PRE>
<P>
Provides Base32 encoding and decoding as defined by <a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>.
<p>
The class can be parameterized in the following manner with various constructors:
<ul>
<li>Whether to use the "base32hex" variant instead of the default "base32"</li>
<li>Line length: Default 76. Line length that aren't multiples of 8 will still essentially end up being multiples of
8 in the encoded data.
<li>Line separator: Default is CRLF ("\r\n")</li>
</ul>
</p>
<p>
This class operates directly on byte streams, and not character streams.
</p>
<p>
This class is not thread-safe. Each thread should use its own instance.
</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.5</DD>
<DT><B>Version:</B></DT>
<DD>$Revision: 1080712 $</DD>
<DT><B>See Also:</B><DD><a href="http://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a></DL>
<HR>
<P>
<!-- =========== 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>private static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#BITS_PER_ENCODED_BYTE">BITS_PER_ENCODED_BYTE</A></B></CODE>
<BR>
BASE32 characters are 5 bits in length.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#bitWorkArea">bitWorkArea</A></B></CODE>
<BR>
Place holder for the bytes we're dealing with for our based logic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#BYTES_PER_ENCODED_BLOCK">BYTES_PER_ENCODED_BLOCK</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#BYTES_PER_UNENCODED_BLOCK">BYTES_PER_UNENCODED_BLOCK</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#CHUNK_SEPARATOR">CHUNK_SEPARATOR</A></B></CODE>
<BR>
Chunk separator per RFC 2045 section 2.1.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#DECODE_TABLE">DECODE_TABLE</A></B></CODE>
<BR>
This array is a lookup table that translates Unicode characters drawn from the "Base32 Alphabet" (as specified in
Table 3 of RFC 2045) into their 5-bit positive integer equivalents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#decodeSize">decodeSize</A></B></CODE>
<BR>
Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#decodeTable">decodeTable</A></B></CODE>
<BR>
Decode table to use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#ENCODE_TABLE">ENCODE_TABLE</A></B></CODE>
<BR>
This array is a lookup table that translates 5-bit positive integer index values into their "Base32 Alphabet"
equivalents as specified in Table 3 of RFC 2045.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#encodeSize">encodeSize</A></B></CODE>
<BR>
Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#encodeTable">encodeTable</A></B></CODE>
<BR>
Encode table to use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#HEX_DECODE_TABLE">HEX_DECODE_TABLE</A></B></CODE>
<BR>
This array is a lookup table that translates Unicode characters drawn from the "Base32 |Hex Alphabet" (as specified in
Table 3 of RFC 2045) into their 5-bit positive integer equivalents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#HEX_ENCODE_TABLE">HEX_ENCODE_TABLE</A></B></CODE>
<BR>
This array is a lookup table that translates 5-bit positive integer index values into their "Base32 Hex Alphabet"
equivalents as specified in Table 3 of RFC 2045.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#lineSeparator">lineSeparator</A></B></CODE>
<BR>
Line separator for encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#MASK_5BITS">MASK_5BITS</A></B></CODE>
<BR>
Mask used to extract 5 bits, used when encoding Base32 bytes</TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.commons.codec.binary.BaseNCodec"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.commons.codec.binary.<A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#buffer">buffer</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#currentLinePos">currentLinePos</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#eof">eof</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#lineLength">lineLength</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#MASK_8BITS">MASK_8BITS</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#MIME_CHUNK_SIZE">MIME_CHUNK_SIZE</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#modulus">modulus</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#PAD">PAD</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#PAD_DEFAULT">PAD_DEFAULT</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#PEM_CHUNK_SIZE">PEM_CHUNK_SIZE</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#pos">pos</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#Base32()">Base32</A></B>()</CODE>
<BR>
Creates a Base32 codec used for decoding and encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#Base32(boolean)">Base32</A></B>(boolean useHex)</CODE>
<BR>
Creates a Base32 codec used for decoding and encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#Base32(int)">Base32</A></B>(int lineLength)</CODE>
<BR>
Creates a Base32 codec used for decoding and encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#Base32(int, byte[])">Base32</A></B>(int lineLength,
byte[] lineSeparator)</CODE>
<BR>
Creates a Base32 codec used for decoding and encoding.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#Base32(int, byte[], boolean)">Base32</A></B>(int lineLength,
byte[] lineSeparator,
boolean useHex)</CODE>
<BR>
Creates a Base32 / Base32 Hex codec used for decoding and encoding.</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>(package private) void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#decode(byte[], int, int)">decode</A></B>(byte[] in,
int inPos,
int inAvail)</CODE>
<BR>
Decodes all of the provided data, starting at inPos, for inAvail bytes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#encode(byte[], int, int)">encode</A></B>(byte[] in,
int inPos,
int inAvail)</CODE>
<BR>
Encodes all of the provided data, starting at inPos, for inAvail bytes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/commons/codec/binary/Base32.html#isInAlphabet(byte)">isInAlphabet</A></B>(byte octet)</CODE>
<BR>
Returns whether or not the <code>octet</code> is in the Base32 alphabet.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.commons.codec.binary.BaseNCodec"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.commons.codec.binary.<A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#available()">available</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#containsAlphabetOrPad(byte[])">containsAlphabetOrPad</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#decode(byte[])">decode</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#decode(java.lang.Object)">decode</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#decode(java.lang.String)">decode</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#encode(byte[])">encode</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#encode(java.lang.Object)">encode</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#encodeAsString(byte[])">encodeAsString</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#encodeToString(byte[])">encodeToString</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#ensureBufferSize(int)">ensureBufferSize</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#getDefaultBufferSize()">getDefaultBufferSize</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#getEncodedLength(byte[])">getEncodedLength</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#hasData()">hasData</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#isInAlphabet(byte[], boolean)">isInAlphabet</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#isInAlphabet(java.lang.String)">isInAlphabet</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#isWhiteSpace(byte)">isWhiteSpace</A>, <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#readResults(byte[], int, int)">readResults</A></CODE></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="BITS_PER_ENCODED_BYTE"><!-- --></A><H3>
BITS_PER_ENCODED_BYTE</H3>
<PRE>
private static final int <B>BITS_PER_ENCODED_BYTE</B></PRE>
<DL>
<DD>BASE32 characters are 5 bits in length.
They are formed by taking a block of five octets to form a 40-bit string,
which is converted into eight BASE32 characters.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.codec.binary.Base32.BITS_PER_ENCODED_BYTE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BYTES_PER_ENCODED_BLOCK"><!-- --></A><H3>
BYTES_PER_ENCODED_BLOCK</H3>
<PRE>
private static final int <B>BYTES_PER_ENCODED_BLOCK</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.codec.binary.Base32.BYTES_PER_ENCODED_BLOCK">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="BYTES_PER_UNENCODED_BLOCK"><!-- --></A><H3>
BYTES_PER_UNENCODED_BLOCK</H3>
<PRE>
private static final int <B>BYTES_PER_UNENCODED_BLOCK</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.codec.binary.Base32.BYTES_PER_UNENCODED_BLOCK">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CHUNK_SEPARATOR"><!-- --></A><H3>
CHUNK_SEPARATOR</H3>
<PRE>
private static final byte[] <B>CHUNK_SEPARATOR</B></PRE>
<DL>
<DD>Chunk separator per RFC 2045 section 2.1.
<P>
<DL>
<DT><B>See Also:</B><DD><a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 2.1</a></DL>
</DL>
<HR>
<A NAME="DECODE_TABLE"><!-- --></A><H3>
DECODE_TABLE</H3>
<PRE>
private static final byte[] <B>DECODE_TABLE</B></PRE>
<DL>
<DD>This array is a lookup table that translates Unicode characters drawn from the "Base32 Alphabet" (as specified in
Table 3 of RFC 2045) into their 5-bit positive integer equivalents. Characters that are not in the Base32
alphabet but fall within the bounds of the array are translated to -1.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="ENCODE_TABLE"><!-- --></A><H3>
ENCODE_TABLE</H3>
<PRE>
private static final byte[] <B>ENCODE_TABLE</B></PRE>
<DL>
<DD>This array is a lookup table that translates 5-bit positive integer index values into their "Base32 Alphabet"
equivalents as specified in Table 3 of RFC 2045.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="HEX_DECODE_TABLE"><!-- --></A><H3>
HEX_DECODE_TABLE</H3>
<PRE>
private static final byte[] <B>HEX_DECODE_TABLE</B></PRE>
<DL>
<DD>This array is a lookup table that translates Unicode characters drawn from the "Base32 |Hex Alphabet" (as specified in
Table 3 of RFC 2045) into their 5-bit positive integer equivalents. Characters that are not in the Base32 Hex
alphabet but fall within the bounds of the array are translated to -1.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="HEX_ENCODE_TABLE"><!-- --></A><H3>
HEX_ENCODE_TABLE</H3>
<PRE>
private static final byte[] <B>HEX_ENCODE_TABLE</B></PRE>
<DL>
<DD>This array is a lookup table that translates 5-bit positive integer index values into their "Base32 Hex Alphabet"
equivalents as specified in Table 3 of RFC 2045.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="MASK_5BITS"><!-- --></A><H3>
MASK_5BITS</H3>
<PRE>
private static final int <B>MASK_5BITS</B></PRE>
<DL>
<DD>Mask used to extract 5 bits, used when encoding Base32 bytes
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.codec.binary.Base32.MASK_5BITS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="bitWorkArea"><!-- --></A><H3>
bitWorkArea</H3>
<PRE>
private long <B>bitWorkArea</B></PRE>
<DL>
<DD>Place holder for the bytes we're dealing with for our based logic.
Bitwise operations store and extract the encoding or decoding from this variable.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="decodeSize"><!-- --></A><H3>
decodeSize</H3>
<PRE>
private final int <B>decodeSize</B></PRE>
<DL>
<DD>Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
<code>decodeSize = <CODE>BYTES_PER_ENCODED_BLOCK</CODE> - 1 + lineSeparator.length;</code>
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="decodeTable"><!-- --></A><H3>
decodeTable</H3>
<PRE>
private final byte[] <B>decodeTable</B></PRE>
<DL>
<DD>Decode table to use.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="encodeSize"><!-- --></A><H3>
encodeSize</H3>
<PRE>
private final int <B>encodeSize</B></PRE>
<DL>
<DD>Convenience variable to help us determine when our buffer is going to run out of room and needs resizing.
<code>encodeSize = <CODE>BYTES_PER_ENCODED_BLOCK</CODE> + lineSeparator.length;</code>
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="encodeTable"><!-- --></A><H3>
encodeTable</H3>
<PRE>
private final byte[] <B>encodeTable</B></PRE>
<DL>
<DD>Encode table to use.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="lineSeparator"><!-- --></A><H3>
lineSeparator</H3>
<PRE>
private final byte[] <B>lineSeparator</B></PRE>
<DL>
<DD>Line separator for encoding. Not used when decoding. Only used if lineLength > 0.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Base32()"><!-- --></A><H3>
Base32</H3>
<PRE>
public <B>Base32</B>()</PRE>
<DL>
<DD>Creates a Base32 codec used for decoding and encoding.
<p>
When encoding the line length is 0 (no chunking).
</p>
<P>
</DL>
<HR>
<A NAME="Base32(boolean)"><!-- --></A><H3>
Base32</H3>
<PRE>
public <B>Base32</B>(boolean useHex)</PRE>
<DL>
<DD>Creates a Base32 codec used for decoding and encoding.
<p>
When encoding the line length is 0 (no chunking).
</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>useHex</CODE> - if <code>true</code> then use Base32 Hex alphabet</DL>
</DL>
<HR>
<A NAME="Base32(int)"><!-- --></A><H3>
Base32</H3>
<PRE>
public <B>Base32</B>(int lineLength)</PRE>
<DL>
<DD>Creates a Base32 codec used for decoding and encoding.
<p>
When encoding the line length is given in the constructor, the line separator is CRLF.
</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>lineLength</CODE> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.</DL>
</DL>
<HR>
<A NAME="Base32(int, byte[])"><!-- --></A><H3>
Base32</H3>
<PRE>
public <B>Base32</B>(int lineLength,
byte[] lineSeparator)</PRE>
<DL>
<DD>Creates a Base32 codec used for decoding and encoding.
<p>
When encoding the line length and line separator are given in the constructor.
</p>
<p>
Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>lineLength</CODE> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.<DD><CODE>lineSeparator</CODE> - Each line of encoded data will end with this sequence of bytes.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The provided lineSeparator included some Base32 characters. That's not going to work!</DL>
</DL>
<HR>
<A NAME="Base32(int, byte[], boolean)"><!-- --></A><H3>
Base32</H3>
<PRE>
public <B>Base32</B>(int lineLength,
byte[] lineSeparator,
boolean useHex)</PRE>
<DL>
<DD>Creates a Base32 / Base32 Hex codec used for decoding and encoding.
<p>
When encoding the line length and line separator are given in the constructor.
</p>
<p>
Line lengths that aren't multiples of 8 will still essentially end up being multiples of 8 in the encoded data.
</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>lineLength</CODE> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 8).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.<DD><CODE>lineSeparator</CODE> - Each line of encoded data will end with this sequence of bytes.<DD><CODE>useHex</CODE> - if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - The provided lineSeparator included some Base32 characters. That's not going to work!
Or the lineLength > 0 and lineSeparator is null.</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="decode(byte[], int, int)"><!-- --></A><H3>
decode</H3>
<PRE>
void <B>decode</B>(byte[] in,
int inPos,
int inAvail)</PRE>
<DL>
<DD><p>
Decodes all of the provided data, starting at inPos, for inAvail bytes. Should be called at least twice: once
with the data to decode, and once with inAvail set to "-1" to alert decoder that EOF has been reached. The "-1"
call is not necessary when decoding, but it doesn't hurt, either.
</p>
<p>
Ignores all non-Base32 characters. This is how chunked (e.g. 76 character) data is handled, since CR and LF are
silently ignored, but has implications for other bytes, too. This method subscribes to the garbage-in,
garbage-out philosophy: it will not check the provided data for validity.
</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#decode(byte[], int, int)">decode</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - byte[] array of ascii data to Base32 decode.<DD><CODE>inPos</CODE> - Position to start reading data from.<DD><CODE>inAvail</CODE> - Amount of bytes available from input for encoding.
Output is written to <A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#buffer"><CODE>BaseNCodec.buffer</CODE></A> as 8-bit octets, using <CODE>pos</CODE> as the buffer position</DL>
</DD>
</DL>
<HR>
<A NAME="encode(byte[], int, int)"><!-- --></A><H3>
encode</H3>
<PRE>
void <B>encode</B>(byte[] in,
int inPos,
int inAvail)</PRE>
<DL>
<DD><p>
Encodes all of the provided data, starting at inPos, for inAvail bytes. Must be called at least twice: once with
the data to encode, and once with inAvail set to "-1" to alert encoder that EOF has been reached, so flush last
remaining bytes (if not multiple of 5).
</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#encode(byte[], int, int)">encode</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - byte[] array of binary data to Base32 encode.<DD><CODE>inPos</CODE> - Position to start reading data from.<DD><CODE>inAvail</CODE> - Amount of bytes available from input for encoding.</DL>
</DD>
</DL>
<HR>
<A NAME="isInAlphabet(byte)"><!-- --></A><H3>
isInAlphabet</H3>
<PRE>
public boolean <B>isInAlphabet</B>(byte octet)</PRE>
<DL>
<DD>Returns whether or not the <code>octet</code> is in the Base32 alphabet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html#isInAlphabet(byte)">isInAlphabet</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/codec/binary/BaseNCodec.html" title="class in org.apache.commons.codec.binary">BaseNCodec</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>octet</CODE> - The value to test
<DT><B>Returns:</B><DD><code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" 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_bottom_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="class-use/Base32.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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/apache/commons/codec/binary/Base32InputStream.html" title="class in org.apache.commons.codec.binary"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/commons/codec/binary/Base32.html" target="_top"><B>FRAMES</B></A>
<A HREF="Base32.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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
commons-codec version 1.5-SNAPSHOT - Copyright © 2002-2011 - Apache Software Foundation
</BODY>
</HTML>
|