← Back to branch summary

~s-friedemann/tomdroid/sshfs

« back to all changes in this revision

Viewing changes to lib/commons-codec-1.4/apidocs/org/apache/commons/codec/StringEncoder.html

  • Committer: Guilherme Salgado
  • Date: 2010-08-31 21:44:24 UTC
  • mfrom: (185.1.51 sync-ui)
  • mto: (185.1.54 sync-ui)
  • mto: This revision was merged to the branch mainline in revision 186.
  • Revision ID: salgado@canonical.com-20100831214424-06b64zz707lwpmcl
merge lp:~tomdroid-developers/sync-ui

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/commons-codec-1.4/apidocs/org/apache/commons/codec/StringEncoder.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
 
<!--NewPage-->
3
 
<HTML>
4
 
<HEAD>
5
 
<!-- Generated by javadoc (build 1.6.0_07) on Thu Aug 06 17:42:38 BST 2009 -->
6
 
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7
 
<TITLE>
8
 
StringEncoder (Commons Codec 1.4 API)
9
 
</TITLE>
10
 
 
11
 
<META NAME="date" CONTENT="2009-08-06">
12
 
 
13
 
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
 
 
15
 
<SCRIPT type="text/javascript">
16
 
function windowTitle()
17
 
{
18
 
    if (location.href.indexOf('is-external=true') == -1) {
19
 
        parent.document.title="StringEncoder (Commons Codec 1.4 API)";
20
 
    }
21
 
}
22
 
</SCRIPT>
23
 
<NOSCRIPT>
24
 
</NOSCRIPT>
25
 
 
26
 
</HEAD>
27
 
 
28
 
<BODY BGCOLOR="white" onload="windowTitle();">
29
 
<HR>
30
 
 
31
 
 
32
 
<!-- ========= START OF TOP NAVBAR ======= -->
33
 
<A NAME="navbar_top"><!-- --></A>
34
 
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36
 
<TR>
37
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38
 
<A NAME="navbar_top_firstrow"><!-- --></A>
39
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40
 
  <TR ALIGN="center" VALIGN="top">
41
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StringEncoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49
 
  </TR>
50
 
</TABLE>
51
 
</TD>
52
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53
 
</EM>
54
 
</TD>
55
 
</TR>
56
 
 
57
 
<TR>
58
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59
 
&nbsp;<A HREF="../../../../org/apache/commons/codec/StringDecoder.html" title="interface in org.apache.commons.codec"><B>PREV CLASS</B></A>&nbsp;
60
 
&nbsp;<A HREF="../../../../org/apache/commons/codec/StringEncoderComparator.html" title="class in org.apache.commons.codec"><B>NEXT CLASS</B></A></FONT></TD>
61
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62
 
  <A HREF="../../../../index.html?org/apache/commons/codec/StringEncoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
63
 
&nbsp;<A HREF="StringEncoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
64
 
&nbsp;<SCRIPT type="text/javascript">
65
 
  <!--
66
 
  if(window==top) {
67
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68
 
  }
69
 
  //-->
70
 
</SCRIPT>
71
 
<NOSCRIPT>
72
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
73
 
</NOSCRIPT>
74
 
 
75
 
 
76
 
</FONT></TD>
77
 
</TR>
78
 
<TR>
79
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
83
 
</TR>
84
 
</TABLE>
85
 
<A NAME="skip-navbar_top"></A>
86
 
<!-- ========= END OF TOP NAVBAR ========= -->
87
 
 
88
 
<HR>
89
 
<!-- ======== START OF CLASS DATA ======== -->
90
 
<H2>
91
 
<FONT SIZE="-1">
92
 
org.apache.commons.codec</FONT>
93
 
<BR>
94
 
Interface StringEncoder</H2>
95
 
<DL>
96
 
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></DD>
97
 
</DL>
98
 
<DL>
99
 
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/commons/codec/net/BCodec.html" title="class in org.apache.commons.codec.net">BCodec</A>, <A HREF="../../../../org/apache/commons/codec/language/Caverphone.html" title="class in org.apache.commons.codec.language">Caverphone</A>, <A HREF="../../../../org/apache/commons/codec/language/DoubleMetaphone.html" title="class in org.apache.commons.codec.language">DoubleMetaphone</A>, <A HREF="../../../../org/apache/commons/codec/language/Metaphone.html" title="class in org.apache.commons.codec.language">Metaphone</A>, <A HREF="../../../../org/apache/commons/codec/net/QCodec.html" title="class in org.apache.commons.codec.net">QCodec</A>, <A HREF="../../../../org/apache/commons/codec/net/QuotedPrintableCodec.html" title="class in org.apache.commons.codec.net">QuotedPrintableCodec</A>, <A HREF="../../../../org/apache/commons/codec/language/RefinedSoundex.html" title="class in org.apache.commons.codec.language">RefinedSoundex</A>, <A HREF="../../../../org/apache/commons/codec/language/Soundex.html" title="class in org.apache.commons.codec.language">Soundex</A>, <A HREF="../../../../org/apache/commons/codec/net/URLCodec.html" title="class in org.apache.commons.codec.net">URLCodec</A></DD>
100
 
</DL>
101
 
<HR>
102
 
<DL>
103
 
<DT><PRE>public interface <A HREF="../../../../src-html/org/apache/commons/codec/StringEncoder.html#line.26"><B>StringEncoder</B></A><DT>extends <A HREF="../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></DL>
104
 
</PRE>
105
 
 
106
 
<P>
107
 
Encodes a String into a String.
108
 
<P>
109
 
 
110
 
<P>
111
 
<DL>
112
 
<DT><B>Version:</B></DT>
113
 
  <DD>$Id: StringEncoder.java 651573 2008-04-25 11:11:21Z niallp $</DD>
114
 
<DT><B>Author:</B></DT>
115
 
  <DD>Apache Software Foundation</DD>
116
 
</DL>
117
 
<HR>
118
 
 
119
 
<P>
120
 
 
121
 
<!-- ========== METHOD SUMMARY =========== -->
122
 
 
123
 
<A NAME="method_summary"><!-- --></A>
124
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127
 
<B>Method Summary</B></FONT></TH>
128
 
</TR>
129
 
<TR BGCOLOR="white" CLASS="TableRowColor">
130
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131
 
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
132
 
<TD><CODE><B><A HREF="../../../../org/apache/commons/codec/StringEncoder.html#encode(java.lang.String)">encode</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pString)</CODE>
133
 
 
134
 
<BR>
135
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encodes a String and returns a String.</TD>
136
 
</TR>
137
 
</TABLE>
138
 
&nbsp;<A NAME="methods_inherited_from_class_org.apache.commons.codec.Encoder"><!-- --></A>
139
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140
 
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141
 
<TH ALIGN="left"><B>Methods inherited from interface org.apache.commons.codec.<A HREF="../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</A></B></TH>
142
 
</TR>
143
 
<TR BGCOLOR="white" CLASS="TableRowColor">
144
 
<TD><CODE><A HREF="../../../../org/apache/commons/codec/Encoder.html#encode(java.lang.Object)">encode</A></CODE></TD>
145
 
</TR>
146
 
</TABLE>
147
 
&nbsp;
148
 
<P>
149
 
 
150
 
<!-- ============ METHOD DETAIL ========== -->
151
 
 
152
 
<A NAME="method_detail"><!-- --></A>
153
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155
 
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
156
 
<B>Method Detail</B></FONT></TH>
157
 
</TR>
158
 
</TABLE>
159
 
 
160
 
<A NAME="encode(java.lang.String)"><!-- --></A><H3>
161
 
encode</H3>
162
 
<PRE>
163
 
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/codec/StringEncoder.html#line.38"><B>encode</B></A>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;pString)
164
 
              throws <A HREF="../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></PRE>
165
 
<DL>
166
 
<DD>Encodes a String and returns a String.
167
 
<P>
168
 
<DD><DL>
169
 
</DL>
170
 
</DD>
171
 
<DD><DL>
172
 
<DT><B>Parameters:</B><DD><CODE>pString</CODE> - a String to encode
173
 
<DT><B>Returns:</B><DD>the encoded String
174
 
<DT><B>Throws:</B>
175
 
<DD><CODE><A HREF="../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</A></CODE> - thrown if there is
176
 
  an error conidition during the Encoding process.</DL>
177
 
</DD>
178
 
</DL>
179
 
<!-- ========= END OF CLASS DATA ========= -->
180
 
<HR>
181
 
 
182
 
 
183
 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
184
 
<A NAME="navbar_bottom"><!-- --></A>
185
 
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
186
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
187
 
<TR>
188
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
189
 
<A NAME="navbar_bottom_firstrow"><!-- --></A>
190
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
191
 
  <TR ALIGN="center" VALIGN="top">
192
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
193
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
194
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
195
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/StringEncoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
196
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
197
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
198
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
199
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
200
 
  </TR>
201
 
</TABLE>
202
 
</TD>
203
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
204
 
</EM>
205
 
</TD>
206
 
</TR>
207
 
 
208
 
<TR>
209
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
210
 
&nbsp;<A HREF="../../../../org/apache/commons/codec/StringDecoder.html" title="interface in org.apache.commons.codec"><B>PREV CLASS</B></A>&nbsp;
211
 
&nbsp;<A HREF="../../../../org/apache/commons/codec/StringEncoderComparator.html" title="class in org.apache.commons.codec"><B>NEXT CLASS</B></A></FONT></TD>
212
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
213
 
  <A HREF="../../../../index.html?org/apache/commons/codec/StringEncoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
214
 
&nbsp;<A HREF="StringEncoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
215
 
&nbsp;<SCRIPT type="text/javascript">
216
 
  <!--
217
 
  if(window==top) {
218
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
219
 
  }
220
 
  //-->
221
 
</SCRIPT>
222
 
<NOSCRIPT>
223
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
224
 
</NOSCRIPT>
225
 
 
226
 
 
227
 
</FONT></TD>
228
 
</TR>
229
 
<TR>
230
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
231
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
232
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
233
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
234
 
</TR>
235
 
</TABLE>
236
 
<A NAME="skip-navbar_bottom"></A>
237
 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
238
 
 
239
 
<HR>
240
 
Copyright &#169; 2002-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
241
 
</BODY>
242
 
</HTML>