base64u.html

java base64

<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="DEBUGGING"><!-- --></A><H3>
DEBUGGING</H3>
<PRE>
protected static final boolean <B>DEBUGGING</B></PRE>
<DL>
<DD>used to disable test driver.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.mindprod.base64.Base64u.DEBUGGING">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="IGNORE"><!-- --></A><H3>
IGNORE</H3>
<PRE>
protected static final int <B>IGNORE</B></PRE>
<DL>
<DD>Marker value for chars we just ignore, e.g. \n \r high ascii.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.mindprod.base64.Base64u.IGNORE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PAD"><!-- --></A><H3>
PAD</H3>
<PRE>
protected static final int <B>PAD</B></PRE>
<DL>
<DD>Marker for = trailing pad.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.mindprod.base64.Base64u.PAD">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="lineSeparator"><!-- --></A><H3>
lineSeparator</H3>
<PRE>
protected java.lang.String <B>lineSeparator</B></PRE>
<DL>
<DD>how we separate lines, e.g. \n, \r\n, \r etc.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="valueToChar"><!-- --></A><H3>
valueToChar</H3>
<PRE>
protected char[] <B>valueToChar</B></PRE>
<DL>
<DD>letter of the alphabet used to encode binary values 0..63, overridden in Base64u.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="spec1"><!-- --></A><H3>
spec1</H3>
<PRE>
protected char <B>spec1</B></PRE>
<DL>
<DD>special character 1, will be - in Base64u.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="spec2"><!-- --></A><H3>
spec2</H3>
<PRE>
protected char <B>spec2</B></PRE>
<DL>
<DD>special character 2, will be _ in Base64u.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="spec3"><!-- --></A><H3>
spec3</H3>
<PRE>
protected char <B>spec3</B></PRE>
<DL>
<DD>special character 3, will be * in Base64u.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="charToValue"><!-- --></A><H3>
charToValue</H3>
<PRE>
protected int[] <B>charToValue</B></PRE>
<DL>
<DD>binary value encoded by a given letter of the alphabet 0..63, overridden in Base64u.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="lineLength"><!-- --></A><H3>
lineLength</H3>
<PRE>
protected int <B>lineLength</B></PRE>
<DL>
<DD>max chars per line, excluding lineSeparator. A multiple of 4.
<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="Base64u()"><!-- --></A><H3>
Base64u</H3>
<PRE>
public <B>Base64u</B>()</PRE>
<DL>
<DD>constructor.
<P>
</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="main(java.lang.String[])"><!-- --></A><H3>
main</H3>
<PRE>
public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
<DL>
<DD>test driver.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - not used .</DL>
</DD>
</DL>
<HR>

<A NAME="show(byte[])"><!-- --></A><H3>
show</H3>
<PRE>
public static void <B>show</B>(byte[]&nbsp;b)</PRE>
<DL>
<DD>debug display array as hex.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>b</CODE> - byte array to display.</DL>
</DD>
</DL>
<HR>

<A NAME="decode(java.lang.String)"><!-- --></A><H3>
decode</H3>
<PRE>
public byte[] <B>decode</B>(java.lang.String&nbsp;s)</PRE>
<DL>
<DD>decode a well-formed complete Base64 string back into an array of bytes. It must have an even multiple of 4 data
 characters (not counting \n), padded out with = as needed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - base64-encoded string
<DT><B>Returns:</B><DD>plaintext as a byte array.</DL>
</DD>
</DL>
<HR>

<A NAME="encode(byte[])"><!-- --></A><H3>
encode</H3>
<PRE>
public java.lang.String <B>encode</B>(byte[]&nbsp;b)</PRE>
<DL>
<DD>Encode an arbitrary array of bytes as Base64 printable ASCII. It will be broken into lines of 72 chars each. The
 last line is not terminated with a line separator. The output will always have an even multiple of data
 characters, exclusive of \n. It is padded out with =.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>b</CODE> - byte array to encode, typically produced by a ByteArrayOutputStream.
<DT><B>Returns:</B><DD>base-64 encoded String, not char[] or byte[].</DL>
</DD>
</DL>
<HR>

<A NAME="setLineLength(int)"><!-- --></A><H3>
setLineLength</H3>
<PRE>
public final void <B>setLineLength</B>(int&nbsp;length)</PRE>
<DL>
<DD>determines how long the lines are that are generated by encode. Ignored by decode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>length</CODE> - 0 means no newlines inserted. Must be a multiple of 4.</DL>
</DD>
</DL>
<HR>

<A NAME="setLineSeparator(java.lang.String)"><!-- --></A><H3>
setLineSeparator</H3>
<PRE>
public final void <B>setLineSeparator</B>(java.lang.String&nbsp;lineSeparator)</PRE>
<DL>
<DD>How lines are separated. Ignored by decode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lineSeparator</CODE> - may be "" but not null. Usually contains only a combination of chars \n and \r. Could be any
                      chars not in set A-Z a-z 0-9 + /.</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="../../../com/mindprod/base64/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Base64u.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../com/mindprod/base64/Example.html" title="class in com.mindprod.base64"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?com/mindprod/base64/Base64u.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Base64u.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>