|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.util.httputil.FastURLEncoder
CharEscapers.uriEscaper()
,
CharEscapers.cppUriEscaper()
or create your
own custom PercentEscaper
.
Almost every use of FastURLEncoder can now be replaced with an instance of the PercentEscaper class, which is much faster.
In most cases it should be possible to use the static instances available
from CharEscapers
but it is also possible to
create your own escaper with custom behaviour.
See Deprecating FastURLEncoder for more information.
Note that the new uriEscaper only escapes using UTF-8 encoding and while no examples of other encodings were found when preparing this class for deprecation, it's possible that some instance were missed. If you have a valid reason to escape URIs via an encoding other than UTF-8 please let the java-libraries-team know.
FastURLEncoder is intended as a replacement for the slow and inefficient java.net.URLEncoder. There are a few differences though:
It is possible that URLEncoder is doing really complicated stuff for a reason and that I just don't understand why. If you are unsure of FastURLEncoder just call FastURLEncoder.setVerifyAgainstJava(true). This will run both versions and verify that the outputs are the same. Of course this will be slow but it is useful for testing. I wouldn't be surprised if the two differ for non-latin1, non-utf-8 encodings.
FastURLEncoder requires jdk 1.5.
@Deprecated public class FastURLEncoder
URLEncoder
Field Summary | |
---|---|
static java.util.BitSet |
CPLUSPLUS_COMPAT_SAFE_OCTETS
Deprecated. Use CharEscapers.cppUriEscaper() |
Constructor Summary | |
---|---|
FastURLEncoder()
Deprecated. |
Method Summary | |
---|---|
static java.util.BitSet |
createSafeOctetBitSet()
Deprecated. |
static java.lang.String |
encode(java.lang.String s)
Deprecated. Use CharEscapers.uriEscaper() . |
static void |
encode(java.lang.String s,
java.lang.Appendable out)
Deprecated. Use CharEscapers.uriEscaper() .
See FastURLEncoder for more details. |
static java.lang.String |
encode(java.lang.String s,
java.util.BitSet safeOctets,
boolean plusForSpace)
Deprecated. Use CharEscapers.uriEscaper() .
or create an instance of PercentEscaper .
See FastURLEncoder for more details. |
static java.lang.String |
encode(java.lang.String s,
java.lang.String encoding)
Deprecated. Use CharEscapers.uriEscaper() .
See FastURLEncoder for more details. |
static void |
encode(java.lang.String s,
java.lang.String encoding,
java.lang.Appendable out)
Deprecated. Use CharEscapers.uriEscaper() .
See FastURLEncoder for more details. |
static java.lang.String |
encode(java.lang.String s,
java.lang.String encoding,
java.util.BitSet safeOctets,
boolean plusForSpace)
Deprecated. Use CharEscapers.uriEscaper()
or create an instance of PercentEscaper .
See FastURLEncoder for more details. |
static boolean |
encode(java.lang.String s,
java.lang.String encoding,
java.util.BitSet safeOctets,
boolean plusForSpace,
java.lang.Appendable out)
Deprecated. Use CharEscapers.uriEscaper()
or create an instance of PercentEscaper .
See FastURLEncoder for more details. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
@Deprecated public static final java.util.BitSet CPLUSPLUS_COMPAT_SAFE_OCTETS
CharEscapers.cppUriEscaper()
Constructor Detail |
---|
public FastURLEncoder()
Method Detail |
---|
@Deprecated public static java.lang.String encode(java.lang.String s, java.lang.String encoding, java.util.BitSet safeOctets, boolean plusForSpace) throws java.io.UnsupportedEncodingException
CharEscapers.uriEscaper()
or create an instance of PercentEscaper
.
See FastURLEncoder
for more details.
s
- String to encode.encoding
- character encoding to use (e.g., "UTF-8")safeOctets
- set of octets that should not be escaped.plusForSpace
- whether octet 0x20, i.e. "space", should be encoded as
a plus sign rather than "%20". Note that this parameter is effectively
ignored if 0x20 is in safeOctets.
s
. Will return s
itself if no encoding is necessary.
java.io.UnsupportedEncodingException
- if encoding
is not supported.@Deprecated public static boolean encode(java.lang.String s, java.lang.String encoding, java.util.BitSet safeOctets, boolean plusForSpace, java.lang.Appendable out) throws java.io.UnsupportedEncodingException, java.io.IOException
CharEscapers.uriEscaper()
or create an instance of PercentEscaper
.
See FastURLEncoder
for more details.
s
- String to encode.encoding
- character encoding to use (e.g., "UTF-8")safeOctets
- set of octets that should not be escaped.plusForSpace
- whether octet 0x20, i.e. "space", should be encoded as
a plus sign rather than "%20". Note that this parameter is effectively
ignored if 0x20 is in safeOctets.out
- the Appendable destination for the encoded string.
s
did need escaping, false otherwise. In
other words, this returns false only if s
was output to
out
verbatim.
java.io.UnsupportedEncodingException
- if encoding
is not supported.
java.io.IOException
- if out
does so when appended to.@Deprecated public static java.lang.String encode(java.lang.String s, java.lang.String encoding) throws java.io.UnsupportedEncodingException
CharEscapers.uriEscaper()
.
See FastURLEncoder
for more details.
s
- String to encode.encoding
- character encoding to use (e.g., "UTF-8")
java.io.UnsupportedEncodingException
URLEncoder.encode(String, String)
@Deprecated public static void encode(java.lang.String s, java.lang.String encoding, java.lang.Appendable out) throws java.io.UnsupportedEncodingException, java.io.IOException
CharEscapers.uriEscaper()
.
See FastURLEncoder
for more details.
s
- String to encode.encoding
- character encoding to use (e.g., "UTF-8")out
- the Appendable destination for the encoded string.
java.io.UnsupportedEncodingException
- if encoding
is not supported.
java.io.IOException
- if out
does so when appended to.URLEncoder.encode(String, String)
@Deprecated public static java.lang.String encode(java.lang.String s)
CharEscapers.uriEscaper()
.
s
- String to encode.URLEncoder.encode(String)
@Deprecated public static void encode(java.lang.String s, java.lang.Appendable out) throws java.io.IOException
CharEscapers.uriEscaper()
.
See FastURLEncoder
for more details.
s
- String to encode.out
- the Appendable destination for the encoded string.
java.io.IOException
URLEncoder.encode(String)
@Deprecated public static java.lang.String encode(java.lang.String s, java.util.BitSet safeOctets, boolean plusForSpace)
CharEscapers.uriEscaper()
.
or create an instance of PercentEscaper
.
See FastURLEncoder
for more details.
s
- String to encode.safeOctets
- set of octets that should not be escaped.plusForSpace
- whether octet 0x20, i.e., "space", should be encoded as
a plus sign rather than "%20". Note that this parameter is effectively
ignored if 0x20 is in safeOctets.URLEncoder.encode(String)
public static java.util.BitSet createSafeOctetBitSet()
encode(String,String,BitSet,boolean)
or
encode(String,BitSet,boolean)
. It defaults to containing the
octets that would not be escaped by
URLEncoder.encode(String)
. Callers can edit the
result for specialized purposes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |