← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/apidocs/org/apache/commons/httpclient/util/EncodingUtil.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:
docs/apidocs/org/apache/commons/httpclient/util/EncodingUtil.html
 
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  EncodingUtil
 
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/EncodingUtil.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;<A HREF="../../../../../org/apache/commons/httpclient/util/DateParser.html"><B>PREV CLASS</B></A>&nbsp;
 
40
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/HttpURLConnection.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="EncodingUtil.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  EncodingUtil</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.EncodingUtil</B>
 
65
</PRE>
 
66
<HR>
 
67
<DL>
 
68
<DT>public class <B>EncodingUtil</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html">Object</A></DL>
 
69
 
 
70
<P>
 
71
The home for utility methods that handle various encoding tasks.
 
72
<P>
 
73
<DL>
 
74
<DT><B>Since: </B><DD>2.0 final</DD>
 
75
<DT><B>Author: </B><DD>Michael Becke</DD>
 
76
</DL>
 
77
<HR>
 
78
 
 
79
<P>
 
80
<!-- ======== INNER CLASS SUMMARY ======== -->
 
81
 
 
82
 
 
83
<!-- =========== FIELD SUMMARY =========== -->
 
84
 
 
85
 
 
86
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
87
 
 
88
 
 
89
<!-- ========== METHOD SUMMARY =========== -->
 
90
 
 
91
<A NAME="method_summary"><!-- --></A>
 
92
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
93
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
94
<TD COLSPAN=2><FONT SIZE="+2">
 
95
<B>Method Summary</B></FONT></TD>
 
96
</TR>
 
97
<TR BGCOLOR="white" CLASS="TableRowColor">
 
98
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
99
<CODE>(package private) static&nbsp;void</CODE></FONT></TD>
 
100
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/EncodingUtil.html#<clinit>()"><clinit></A></B>()</CODE>
 
101
 
 
102
<BR>
 
103
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
104
</TR>
 
105
<TR BGCOLOR="white" CLASS="TableRowColor">
 
106
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
107
<CODE>static&nbsp;<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 
108
<TD><CODE><B><A HREF="../../../../../org/apache/commons/httpclient/util/EncodingUtil.html#formUrlEncode(org.apache.commons.httpclient.NameValuePair[], java.lang.String)">formUrlEncode</A></B>(<A HREF="../../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</A>[]&nbsp;pairs,
 
109
              <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;charset)</CODE>
 
110
 
 
111
<BR>
 
112
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Form-urlencoding routine.</TD>
 
113
</TR>
 
114
</TABLE>
 
115
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
116
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
117
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
118
<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>
 
119
</TR>
 
120
<TR BGCOLOR="white" CLASS="TableRowColor">
 
121
<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>
 
122
</TR>
 
123
</TABLE>
 
124
&nbsp;
 
125
<P>
 
126
 
 
127
<!-- ============ FIELD DETAIL =========== -->
 
128
 
 
129
 
 
130
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
131
 
 
132
 
 
133
<!-- ============ METHOD DETAIL ========== -->
 
134
 
 
135
<A NAME="method_detail"><!-- --></A>
 
136
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
137
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
138
<TD COLSPAN=1><FONT SIZE="+2">
 
139
<B>Method Detail</B></FONT></TD>
 
140
</TR>
 
141
</TABLE>
 
142
 
 
143
<A NAME="<clinit>()"><!-- --></A><H3>
 
144
<clinit></H3>
 
145
<PRE>
 
146
static void <B><clinit></B>()</PRE>
 
147
<DL>
 
148
</DL>
 
149
<HR>
 
150
 
 
151
<A NAME="formUrlEncode(org.apache.commons.httpclient.NameValuePair[], java.lang.String)"><!-- --></A><H3>
 
152
formUrlEncode</H3>
 
153
<PRE>
 
154
public static <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A> <B>formUrlEncode</B>(<A HREF="../../../../../org/apache/commons/httpclient/NameValuePair.html">NameValuePair</A>[]&nbsp;pairs,
 
155
                                   <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html">String</A>&nbsp;charset)</PRE>
 
156
<DL>
 
157
<DD>Form-urlencoding routine.
 
158
 
 
159
 The default encoding for all forms is `application/x-www-form-urlencoded'. 
 
160
 A form data set is represented in this media type as follows:
 
161
 
 
162
 The form field names and values are escaped: space characters are replaced 
 
163
 by `+', and then reserved characters are escaped as per [URL]; that is, 
 
164
 non-alphanumeric characters are replaced by `%HH', a percent sign and two 
 
165
 hexadecimal digits representing the ASCII code of the character. Line breaks, 
 
166
 as in multi-line text field values, are represented as CR LF pairs, i.e. `%0D%0A'.<DD><DL>
 
167
<DT><B>Parameters:</B><DD><CODE>pairs</CODE> - the values to be encoded<DD><CODE>charset</CODE> - the character set of pairs to be encoded<DT><B>Returns:</B><DD>the urlencoded pairs<DT><B>Since: </B><DD>2.0 final</DD>
 
168
</DL>
 
169
</DD>
 
170
</DL>
 
171
<!-- ========= END OF CLASS DATA ========= -->
 
172
<HR>
 
173
 
 
174
<!-- ========== START OF NAVBAR ========== -->
 
175
<A NAME="navbar_bottom"><!-- --></A>
 
176
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
177
<TR>
 
178
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
179
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
180
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
181
  <TR ALIGN="center" VALIGN="top">
 
182
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
183
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
184
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
185
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/EncodingUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
186
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
187
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
188
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
189
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
190
  </TR>
 
191
</TABLE>
 
192
</TD>
 
193
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
194
</EM>
 
195
</TD>
 
196
</TR>
 
197
 
 
198
<TR>
 
199
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
200
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/DateParser.html"><B>PREV CLASS</B></A>&nbsp;
 
201
&nbsp;<A HREF="../../../../../org/apache/commons/httpclient/util/HttpURLConnection.html"><B>NEXT CLASS</B></A></FONT></TD>
 
202
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
203
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
204
&nbsp;<A HREF="EncodingUtil.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
205
</TR>
 
206
<TR>
 
207
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
208
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
209
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
210
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
211
</TR>
 
212
</TABLE>
 
213
<!-- =========== END OF NAVBAR =========== -->
 
214
 
 
215
<HR>
 
216
Copyright &copy; 2001-2004 Apache Software Foundation. All Rights Reserved.
 
217
</BODY>
 
218
</HTML>