com.isti.util

Class URLRefEncoder

java.lang.Object

com.isti.util.URLRefEncoder

public class URLRefEncoder
extends java.lang.Object

Utility class for HTML form encoding. This class contains static methods for converting a String to the application/x-www-form-urlencoded MIME format. For more information about HTML form encoding, consult the HTML specification.

When encoding a String, the following rules apply:

• The alphanumeric characters "a" through "z", "A" through "Z" and "0" through "9" remain the same.
• The special characters ".", "-", "*", and "_" remain the same.
• The space character " " is converted into a plus sign "+".
• All other characters are unsafe and are first converted into one or more bytes using some encoding scheme. Then each byte is represented by the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the byte. The recommended encoding scheme to use is UTF-8. However, for compatibility reasons, if an encoding is not specified, then the default encoding of the platform is used.

For example using UTF-8 as the encoding scheme the string "The string ü@foo-bar" would get converted to "The+string+%C3%BC%40foo-bar" because in UTF-8 the character ü is encoded as two bytes C3 (hex) and BC (hex), and the character @ is encoded as one byte 40 (hex).

Since:

1.0

Author:

Herb Jellinek

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	caseDiff
static java.nio.charset.Charset	DEFAULT_ENCODING The default encoding
(package private) static java.util.BitSet	dontNeedEncoding

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encode(java.lang.String s) Translates a string into x-www-form-urlencoded format.
static java.lang.String	encode(java.lang.String s, java.nio.charset.Charset charset) Translates a string into application/x-www-form-urlencoded format using a specific Charset.
static java.lang.String	encode(java.lang.String s, java.lang.String enc) Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.
static boolean	encodeChars(java.lang.Appendable out, java.lang.CharSequence cs) Translates a characters into application/x-www-form-urlencoded format using the UTF-8 Charset.
static boolean	encodeChars(java.lang.Appendable out, java.lang.CharSequence cs, java.nio.charset.Charset charset) Translates a characters into application/x-www-form-urlencoded format using a specific Charset.
static boolean	encodeChars(java.lang.Appendable out, java.lang.CharSequence cs, java.nio.charset.Charset charset, java.util.BitSet dontNeedEncoding) Translates a characters into application/x-www-form-urlencoded format using a specific Charset.
static java.lang.CharSequence	encodeChars(java.lang.CharSequence cs) Translates a characters into x-www-form-urlencoded format.
static java.lang.CharSequence	encodeChars(java.lang.CharSequence cs, java.nio.charset.Charset charset) Translates a characters into application/x-www-form-urlencoded format using a specific Charset.

Methods inherited from class java.lang.Object

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

Field Detail

caseDiff

static final int caseDiff

See Also:

Constant Field Values

DEFAULT_ENCODING

public static java.nio.charset.Charset DEFAULT_ENCODING

The default encoding

dontNeedEncoding

static final java.util.BitSet dontNeedEncoding

Method Detail

encode

public static java.lang.String encode(java.lang.String s)

Translates a string into x-www-form-urlencoded format. This method uses UTF-8 as the encoding scheme to obtain the bytes for unsafe characters.

Parameters:

s - String to be translated.

Returns:

the translated CharSequence.

encode

public static java.lang.String encode(java.lang.String s,
                                      java.nio.charset.Charset charset)

Translates a string into application/x-www-form-urlencoded format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

s - String to be translated.

charset - the given charset

Returns:

the translated CharSequence.

Throws:

java.lang.NullPointerException - if s or charset is null.

See Also:

URLDecoder#decode(java.lang.String, java.nio.charset.Charset)

encode

public static java.lang.String encode(java.lang.String s,
                                      java.lang.String enc)
                               throws java.io.UnsupportedEncodingException

Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.

This method behaves the same as encodeChars(String s, Charset charset) except that it will look up the charset using the given encoding name.

Parameters:

s - String to be translated.

enc - The name of a supported character encoding.

Returns:

the translated String.

Throws:

java.io.UnsupportedEncodingException - If the named encoding is not supported

Since:

1.4

See Also:

URLDecoder#decode(java.lang.String, java.lang.String)

encodeChars

public static boolean encodeChars(java.lang.Appendable out,
                                  java.lang.CharSequence cs)
                           throws java.io.IOException

Translates a characters into application/x-www-form-urlencoded format using the UTF-8 Charset. This method uses the charset to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

out - the output.

cs - CharSequence to be translated.

Returns:

true if changed, false otherwise.

Throws:

java.io.IOException - If an I/O error occurs.

java.lang.NullPointerException - if s or charset is null.

See Also:

URLDecoder#decode(java.lang.String, java.nio.charset.Charset)

encodeChars

public static boolean encodeChars(java.lang.Appendable out,
                                  java.lang.CharSequence cs,
                                  java.nio.charset.Charset charset)
                           throws java.io.IOException

Translates a characters into application/x-www-form-urlencoded format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

out - the output.

cs - CharSequence to be translated.

charset - the given charset

Returns:

true if changed, false otherwise.

Throws:

java.io.IOException - If an I/O error occurs.

java.lang.NullPointerException - if s or charset is null.

See Also:

URLDecoder#decode(java.lang.String, java.nio.charset.Charset)

encodeChars

public static boolean encodeChars(java.lang.Appendable out,
                                  java.lang.CharSequence cs,
                                  java.nio.charset.Charset charset,
                                  java.util.BitSet dontNeedEncoding)
                           throws java.io.IOException

Translates a characters into application/x-www-form-urlencoded format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

out - the output.

cs - CharSequence to be translated.

charset - the given charset

dontNeedEncoding - the characters that don't need encoding.

Returns:

true if changed, false otherwise.

Throws:

java.io.IOException - If an I/O error occurs.

java.lang.NullPointerException - if s or charset is null.

See Also:

URLDecoder#decode(java.lang.String, java.nio.charset.Charset)

encodeChars

public static java.lang.CharSequence encodeChars(java.lang.CharSequence cs)

Translates a characters into x-www-form-urlencoded format. This method uses UTF-8 as the encoding scheme to obtain the bytes for unsafe characters.

Parameters:

cs - CharSequence to be translated.

Returns:

the translated CharSequence.

encodeChars

public static java.lang.CharSequence encodeChars(java.lang.CharSequence cs,
                                                 java.nio.charset.Charset charset)

Translates a characters into application/x-www-form-urlencoded format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters.

Note: The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters:

cs - CharSequence to be translated.

charset - the given charset

Returns:

the translated CharSequence.

Throws:

java.lang.NullPointerException - if s or charset is null.

See Also:

URLDecoder#decode(java.lang.String, java.nio.charset.Charset)