~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/util/Base64.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Hawkins
  • Date: 2005-11-25 13:12:23 UTC
  • Revision ID: james.westby@ubuntu.com-20051125131223-2g7eyo21pqgrohpo
Tags: upstream-2.0.2
ImportĀ upstreamĀ versionĀ 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc on Sun Oct 10 17:41:05 EDT 2004 -->
 
6
<TITLE>
 
7
HttpClient 2.0.2 API: Class  Base64
 
8
</TITLE>
 
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
10
</HEAD>
 
11
<BODY BGCOLOR="white">
 
12
 
 
13
<!-- ========== START OF NAVBAR ========== -->
 
14
<A NAME="navbar_top"><!-- --></A>
 
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
16
<TR>
 
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
18
<A NAME="navbar_top_firstrow"><!-- --></A>
 
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
20
  <TR ALIGN="center" VALIGN="top">
 
21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Base64.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
28
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
29
  </TR>
 
30
</TABLE>
 
31
</TD>
 
32
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
33
</EM>
 
34
</TD>
 
35
</TR>
 
36
 
 
37
<TR>
 
38
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
39
&nbsp;PREV CLASS&nbsp;
 
40
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/DateParser.html"><B>NEXT CLASS</B></A></FONT></TD>
 
41
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
42
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
43
&nbsp;<A HREF="Base64.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
44
</TR>
 
45
<TR>
 
46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
47
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
48
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
49
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
50
</TR>
 
51
</TABLE>
 
52
<!-- =========== END OF NAVBAR =========== -->
 
53
 
 
54
<HR>
 
55
<!-- ======== START OF CLASS DATA ======== -->
 
56
<H2>
 
57
<FONT SIZE="-1">
 
58
org.apache.commons.httpclient.util</FONT>
 
59
<BR>
 
60
Class  Base64</H2>
 
61
<PRE>
 
62
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">java.lang.Object</A>
 
63
  |
 
64
  +--<B>org.apache.commons.httpclient.util.Base64</B>
 
65
</PRE>
 
66
<HR>
 
67
<B>Deprecated.</B>&nbsp;<I>The commons-codec Base64 class will be used in HttpClient 2.1</I>
 
68
<P>
 
69
<DL>
 
70
<DT>public final class <B>Base64</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></DL>
 
71
 
 
72
<P>
 
73
Base64 encoder and decoder.
 
74
 <p>
 
75
 This class provides encoding/decoding methods for the Base64 encoding as
 
76
 defined by RFC 2045, N. Freed and N. Borenstein. RFC 2045: Multipurpose
 
77
 Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
 
78
 Reference 1996. Available at: 
 
79
 <a href="http://www.ietf.org/rfc/rfc2045.txt">http://www.ietf.org/rfc/rfc2045.txt</a>
 
80
 </p>
 
81
<P>
 
82
<DL>
 
83
<DT><B>Version: </B><DD>$Revision: 1.6.2.1 $ $Date: 2004/02/22 18:21:16 $</DD>
 
84
<DT><B>Author: </B><DD>Jeffrey Rodriguez, <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a></DD>
 
85
</DL>
 
86
<HR>
 
87
 
 
88
<P>
 
89
<!-- ======== INNER CLASS SUMMARY ======== -->
 
90
 
 
91
 
 
92
<!-- =========== FIELD SUMMARY =========== -->
 
93
 
 
94
 
 
95
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
96
 
 
97
 
 
98
<!-- ========== METHOD SUMMARY =========== -->
 
99
 
 
100
<A NAME="method_summary"><!-- --></A>
 
101
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
102
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
103
<TD COLSPAN=2><FONT SIZE="+2">
 
104
<B>Method Summary</B></FONT></TD>
 
105
</TR>
 
106
<TR BGCOLOR="white" CLASS="TableRowColor">
 
107
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
108
<CODE>(package private) static&nbsp;void</CODE></FONT></TD>
 
109
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#<clinit>()"><clinit></A></B>()</CODE>
 
110
 
 
111
<BR>
 
112
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;&nbsp;</TD>
 
113
</TR>
 
114
<TR BGCOLOR="white" CLASS="TableRowColor">
 
115
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
116
<CODE>static&nbsp;byte[]</CODE></FONT></TD>
 
117
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#decode(byte[])">decode</A></B>(byte[]&nbsp;base64Data)</CODE>
 
118
 
 
119
<BR>
 
120
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Decodes Base64 data into octects</TD>
 
121
</TR>
 
122
<TR BGCOLOR="white" CLASS="TableRowColor">
 
123
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
124
<CODE>static&nbsp;byte[]</CODE></FONT></TD>
 
125
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#encode(byte[])">encode</A></B>(byte[]&nbsp;binaryData)</CODE>
 
126
 
 
127
<BR>
 
128
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Encodes hex octects into Base64</TD>
 
129
</TR>
 
130
<TR BGCOLOR="white" CLASS="TableRowColor">
 
131
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
132
<CODE>static&nbsp;boolean</CODE></FONT></TD>
 
133
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#isArrayByteBase64(byte[])">isArrayByteBase64</A></B>(byte[]&nbsp;arrayOctect)</CODE>
 
134
 
 
135
<BR>
 
136
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Return true if the specified byte array is base64</TD>
 
137
</TR>
 
138
<TR BGCOLOR="white" CLASS="TableRowColor">
 
139
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
140
<CODE>(package private) static&nbsp;boolean</CODE></FONT></TD>
 
141
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#isBase64(byte)">isBase64</A></B>(byte&nbsp;octect)</CODE>
 
142
 
 
143
<BR>
 
144
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Return true if the specified octect is base64</TD>
 
145
</TR>
 
146
<TR BGCOLOR="white" CLASS="TableRowColor">
 
147
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
148
<CODE>static&nbsp;boolean</CODE></FONT></TD>
 
149
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/Base64.html#isBase64(java.lang.String)">isBase64</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;isValidString)</CODE>
 
150
 
 
151
<BR>
 
152
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Return true if the specified string is base64 encoded.</TD>
 
153
</TR>
 
154
</TABLE>
 
155
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
156
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
157
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
158
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></B></TD>
 
159
</TR>
 
160
<TR BGCOLOR="white" CLASS="TableRowColor">
 
161
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
 
162
</TR>
 
163
</TABLE>
 
164
&nbsp;
 
165
<P>
 
166
 
 
167
<!-- ============ FIELD DETAIL =========== -->
 
168
 
 
169
 
 
170
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
171
 
 
172
 
 
173
<!-- ============ METHOD DETAIL ========== -->
 
174
 
 
175
<A NAME="method_detail"><!-- --></A>
 
176
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
177
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
178
<TD COLSPAN=1><FONT SIZE="+2">
 
179
<B>Method Detail</B></FONT></TD>
 
180
</TR>
 
181
</TABLE>
 
182
 
 
183
<A NAME="<clinit>()"><!-- --></A><H3>
 
184
<clinit></H3>
 
185
<PRE>
 
186
static void <B><clinit></B>()</PRE>
 
187
<DL>
 
188
<DD><B>Deprecated.</B>&nbsp;</DL>
 
189
<HR>
 
190
 
 
191
<A NAME="isBase64(java.lang.String)"><!-- --></A><H3>
 
192
isBase64</H3>
 
193
<PRE>
 
194
public static boolean <B>isBase64</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;isValidString)</PRE>
 
195
<DL>
 
196
<DD><B>Deprecated.</B>&nbsp;<DD>Return true if the specified string is base64 encoded.<DD><DL>
 
197
<DT><B>Parameters:</B><DD><CODE>isValidString</CODE> - The string to test.<DT><B>Returns:</B><DD>boolean True if the string is base64.</DL>
 
198
</DD>
 
199
</DL>
 
200
<HR>
 
201
 
 
202
<A NAME="isBase64(byte)"><!-- --></A><H3>
 
203
isBase64</H3>
 
204
<PRE>
 
205
static boolean <B>isBase64</B>(byte&nbsp;octect)</PRE>
 
206
<DL>
 
207
<DD><B>Deprecated.</B>&nbsp;<DD>Return true if the specified octect is base64<DD><DL>
 
208
<DT><B>Parameters:</B><DD><CODE>octect</CODE> - The octet to test.<DT><B>Returns:</B><DD>boolean True if the octect is base64.</DL>
 
209
</DD>
 
210
</DL>
 
211
<HR>
 
212
 
 
213
<A NAME="isArrayByteBase64(byte[])"><!-- --></A><H3>
 
214
isArrayByteBase64</H3>
 
215
<PRE>
 
216
public static boolean <B>isArrayByteBase64</B>(byte[]&nbsp;arrayOctect)</PRE>
 
217
<DL>
 
218
<DD><B>Deprecated.</B>&nbsp;<DD>Return true if the specified byte array is base64<DD><DL>
 
219
<DT><B>Parameters:</B><DD><CODE>arrayOctect</CODE> - The array to test.<DT><B>Returns:</B><DD>boolean true if the specified byte array is base64</DL>
 
220
</DD>
 
221
</DL>
 
222
<HR>
 
223
 
 
224
<A NAME="encode(byte[])"><!-- --></A><H3>
 
225
encode</H3>
 
226
<PRE>
 
227
public static byte[] <B>encode</B>(byte[]&nbsp;binaryData)</PRE>
 
228
<DL>
 
229
<DD><B>Deprecated.</B>&nbsp;<DD>Encodes hex octects into Base64<DD><DL>
 
230
<DT><B>Parameters:</B><DD><CODE>binaryData</CODE> - Array containing binaryData<DT><B>Returns:</B><DD>Base64-encoded array</DL>
 
231
</DD>
 
232
</DL>
 
233
<HR>
 
234
 
 
235
<A NAME="decode(byte[])"><!-- --></A><H3>
 
236
decode</H3>
 
237
<PRE>
 
238
public static byte[] <B>decode</B>(byte[]&nbsp;base64Data)</PRE>
 
239
<DL>
 
240
<DD><B>Deprecated.</B>&nbsp;<DD>Decodes Base64 data into octects<DD><DL>
 
241
<DT><B>Parameters:</B><DD><CODE>base64Data</CODE> - byte array containing Base64 data<DT><B>Returns:</B><DD>Array containing decoded data.</DL>
 
242
</DD>
 
243
</DL>
 
244
<!-- ========= END OF CLASS DATA ========= -->
 
245
<HR>
 
246
 
 
247
<!-- ========== START OF NAVBAR ========== -->
 
248
<A NAME="navbar_bottom"><!-- --></A>
 
249
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
250
<TR>
 
251
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
252
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
253
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
254
  <TR ALIGN="center" VALIGN="top">
 
255
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
256
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
257
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
258
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Base64.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
259
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
260
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
261
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
262
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
263
  </TR>
 
264
</TABLE>
 
265
</TD>
 
266
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
267
</EM>
 
268
</TD>
 
269
</TR>
 
270
 
 
271
<TR>
 
272
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
273
&nbsp;PREV CLASS&nbsp;
 
274
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/DateParser.html"><B>NEXT CLASS</B></A></FONT></TD>
 
275
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
276
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
277
&nbsp;<A HREF="Base64.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
278
</TR>
 
279
<TR>
 
280
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
281
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
282
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
283
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
284
</TR>
 
285
</TABLE>
 
286
<!-- =========== END OF NAVBAR =========== -->
 
287
 
 
288
<HR>
 
289
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
290
</BODY>
 
291
</HTML>