/lib/bouncycastle/docs/org/bouncycastle/util/encoders/Base64.html
https://bitbucket.org/arkban/somersault · HTML · 384 lines · 315 code · 47 blank · 22 comment · 0 complexity · dd16dd3a2e4af9d2053c21603e8835d3 MD5 · raw file
- <!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) on Mon Jan 11 13:46:41 EST 2010 -->
- <TITLE>
- Base64 (Bouncy Castle Library 1.45 API Specification)
- </TITLE>
- <META NAME="date" CONTENT="2010-01-11">
- <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 (Bouncy Castle Library 1.45 API Specification)";
- }
- }
- </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>
- <b>Bouncy Castle Cryptography Library 1.45</b></EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../org/bouncycastle/util/encoders/Base64Encoder.html" title="class in org.bouncycastle.util.encoders"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/bouncycastle/util/encoders/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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <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.bouncycastle.util.encoders</FONT>
- <BR>
- Class Base64</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.bouncycastle.util.encoders.Base64</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>Base64</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- <HR>
- <P>
- <!-- ======== 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/bouncycastle/util/encoders/Base64.html#Base64()">Base64</A></B>()</CODE>
- <BR>
- </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/bouncycastle/util/encoders/Base64.html#decode(byte[])">decode</A></B>(byte[] data)</CODE>
- <BR>
- decode the base 64 encoded input data.</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/bouncycastle/util/encoders/Base64.html#decode(java.lang.String)">decode</A></B>(java.lang.String data)</CODE>
- <BR>
- decode the base 64 encoded String data - whitespace will be ignored.</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/bouncycastle/util/encoders/Base64.html#decode(java.lang.String, java.io.OutputStream)">decode</A></B>(java.lang.String data,
- java.io.OutputStream out)</CODE>
- <BR>
- decode the base 64 encoded String data writing it to the given output stream,
- whitespace characters will be ignored.</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/bouncycastle/util/encoders/Base64.html#encode(byte[])">encode</A></B>(byte[] data)</CODE>
- <BR>
- encode the input data producing a base 64 encoded byte array.</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/bouncycastle/util/encoders/Base64.html#encode(byte[], int, int, java.io.OutputStream)">encode</A></B>(byte[] data,
- int off,
- int length,
- java.io.OutputStream out)</CODE>
- <BR>
- Encode the byte data to base 64 writing it to the given output stream.</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/bouncycastle/util/encoders/Base64.html#encode(byte[], java.io.OutputStream)">encode</A></B>(byte[] data,
- java.io.OutputStream out)</CODE>
- <BR>
- Encode the byte data to base 64 writing it to the given output stream.</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>
- <!-- ========= 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="Base64()"><!-- --></A><H3>
- Base64</H3>
- <PRE>
- public <B>Base64</B>()</PRE>
- <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(byte[])"><!-- --></A><H3>
- encode</H3>
- <PRE>
- public static byte[] <B>encode</B>(byte[] data)</PRE>
- <DL>
- <DD>encode the input data producing a base 64 encoded byte array.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>a byte array containing the base 64 encoded data.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="encode(byte[], java.io.OutputStream)"><!-- --></A><H3>
- encode</H3>
- <PRE>
- public static int <B>encode</B>(byte[] data,
- java.io.OutputStream out)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Encode the byte data to base 64 writing it to the given output stream.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>the number of bytes produced.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="encode(byte[], int, int, java.io.OutputStream)"><!-- --></A><H3>
- encode</H3>
- <PRE>
- public static int <B>encode</B>(byte[] data,
- int off,
- int length,
- java.io.OutputStream out)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Encode the byte data to base 64 writing it to the given output stream.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>the number of bytes produced.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="decode(byte[])"><!-- --></A><H3>
- decode</H3>
- <PRE>
- public static byte[] <B>decode</B>(byte[] data)</PRE>
- <DL>
- <DD>decode the base 64 encoded input data. It is assumed the input data is valid.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>a byte array representing the decoded data.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="decode(java.lang.String)"><!-- --></A><H3>
- decode</H3>
- <PRE>
- public static byte[] <B>decode</B>(java.lang.String data)</PRE>
- <DL>
- <DD>decode the base 64 encoded String data - whitespace will be ignored.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>a byte array representing the decoded data.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="decode(java.lang.String, java.io.OutputStream)"><!-- --></A><H3>
- decode</H3>
- <PRE>
- public static int <B>decode</B>(java.lang.String data,
- java.io.OutputStream out)
- throws java.io.IOException</PRE>
- <DL>
- <DD>decode the base 64 encoded String data writing it to the given output stream,
- whitespace characters will be ignored.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>the number of bytes produced.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE></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="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>
- <b>Bouncy Castle Cryptography Library 1.45</b></EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- <A HREF="../../../../org/bouncycastle/util/encoders/Base64Encoder.html" title="class in org.bouncycastle.util.encoders"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/bouncycastle/util/encoders/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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <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>
- </BODY>
- </HTML>