oracle.i18n.net
Class URLEncoder

java.lang.Object
  |
  +--oracle.i18n.net.URLEncoder

public class URLEncoder

extends Object

URLEncoder contains a utility method for converting a String into a MIME format called x-www-form-urlencoded format.

To convert a String, each character is examined in turn:

• The ASCII characters 'a' through 'z', 'A' through 'Z', '0' through '9', and ".", "-", "", "_" remain the same.
• The space character ' ' is converted into a plus sign '+'.
• All other characters are converted into the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the lower 8-bits of the character.

When you encode a full set of URL string, e.g., http://www.acme.com/, it is troublesome to encode special meaning characters such as ':' and '/'. To avoid encoding, you can set the parameter of escResChar to false. The following characters will not be encoded:

• ; - Semi-colon (U+003B)
• / - Forwad slash (U+002F)
• ? - Question mark (U+003F)
• : - Colon (U+003A)
• ( - At sign (U+0040)
• & - Ampersand (U+0026)
• = - Equal sign (U+002D)
• + - Plus sign (U+002B)
• $ - Dollar sign (U+0024)
• , - Comma (U+002C)

By default, escResChar is true.

For information about URL encode/decode, see RFC 1738.

Since:

10.1.1

See Also:

RFC 1738

Method Summary

static String	encode(String s) Encodes a String into x-www-form-urlencoded format using UTF-8 character set encoding.
static String	encode(String s, boolean escResChar) Encodes a String into x-www-form-urlencoded format using UTF-8 character set encoding.
static String	encode(String s, boolean escResChar, String enc) Encodes a string into x-www-form-urlencoded format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

public static String encode(String s)

Encodes a String into x-www-form-urlencoded format using UTF-8 character set encoding. Any reserved characters will be encoded.

Parameters:

s - a String to be encoded.

Returns:

the translated String

encode

public static String encode(String s,
                            boolean escResChar)

Encodes a String into x-www-form-urlencoded format using UTF-8 character set encoding. escResChar determines whether it encodes the reserved characters or not.

Parameters:

s - a String to be translated.

escResChar - determines whether to encodes the reserved; true - encode (default), false - don't encode.

Returns:

the translated String

Throws:

IllegalStateException - if UTF-8 is not supported by JVM

encode

public static String encode(String s,
                            boolean escResChar,
                            String enc)
                     throws UnsupportedEncodingException

Encodes a string into x-www-form-urlencoded format.

Currently AL16UTF16(aka. UTF-16BE) is not supported.

Parameters:

s - a String to be translated.

escResChar - determines whether to encodes the reserved; true - encode (default), false - don't encode.

enc - the name of an Oracle or IANA character set

Returns:

the translated String.

Throws:

UnsupportedEncodingException - if the character set is not supported.