org.apache.commons.codec.net
public class URLCodec extends Object implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder
Implements the 'www-form-urlencoded' encoding scheme, also misleadingly known as URL encoding.
For more detailed information please refer to Chapter 17.13.4 'Form content types' of the HTML 4.01 Specification
This codec is meant to be a replacement for standard Java classes java.net.URLEncoder and java.net.URLDecoder on older Java platforms, as these classes in Java versions below 1.4 rely on the platform's default charset encoding.
Since: 1.2
Version: $Id: URLCodec.java 130337 2004-03-29 07:59:00Z ggregory $
Field Summary | |
---|---|
protected String | charset
The default charset used for string decoding and encoding. |
protected static byte | ESCAPE_CHAR |
protected static BitSet | WWW_FORM_URL
BitSet of www-form-url safe characters. |
Constructor Summary | |
---|---|
URLCodec()
Default constructor. | |
URLCodec(String charset)
Constructor which allows for the selection of a default charset
|
Method Summary | |
---|---|
byte[] | decode(byte[] bytes)
Decodes an array of URL safe 7-bit characters into an array of
original bytes. |
String | decode(String pString, String charset)
Decodes a URL safe string into its original form using the
specified encoding. |
String | decode(String pString)
Decodes a URL safe string into its original form using the default
string charset. |
Object | decode(Object pObject)
Decodes a URL safe object into its original form. |
static byte[] | decodeUrl(byte[] bytes)
Decodes an array of URL safe 7-bit characters into an array of
original bytes. |
byte[] | encode(byte[] bytes)
Encodes an array of bytes into an array of URL safe 7-bit
characters. |
String | encode(String pString, String charset)
Encodes a string into its URL safe form using the specified
string charset. |
String | encode(String pString)
Encodes a string into its URL safe form using the default string
charset. |
Object | encode(Object pObject)
Encodes an object into its URL safe form. |
static byte[] | encodeUrl(BitSet urlsafe, byte[] bytes)
Encodes an array of bytes into an array of URL safe 7-bit
characters. |
String | getDefaultCharset()
The default charset used for string decoding and encoding.
|
String | getEncoding()
The String encoding used for decoding and encoding.
|
Parameters: charset the default string charset to use.
Parameters: bytes array of URL safe characters
Returns: array of original bytes
Throws: DecoderException Thrown if URL decoding is unsuccessful
Parameters: pString URL safe string to convert into its original form charset the original string charset
Returns: original string
Throws: DecoderException Thrown if URL decoding is unsuccessful UnsupportedEncodingException Thrown if charset is not supported
Parameters: pString URL safe string to convert into its original form
Returns: original string
Throws: DecoderException Thrown if URL decoding is unsuccessful
See Also: getDefaultCharset
Parameters: pObject URL safe object to convert into its original form
Returns: original object
Throws: DecoderException Thrown if URL decoding is not applicable to objects of this type if decoding is unsuccessful
Parameters: bytes array of URL safe characters
Returns: array of original bytes
Throws: DecoderException Thrown if URL decoding is unsuccessful
Parameters: bytes array of bytes to convert to URL safe characters
Returns: array of bytes containing URL safe characters
Parameters: pString string to convert to a URL safe form charset the charset for pString
Returns: URL safe string
Throws: UnsupportedEncodingException Thrown if charset is not supported
Parameters: pString string to convert to a URL safe form
Returns: URL safe string
Throws: EncoderException Thrown if URL encoding is unsuccessful
See Also: getDefaultCharset
Parameters: pObject string to convert to a URL safe form
Returns: URL safe object
Throws: EncoderException Thrown if URL encoding is not applicable to objects of this type or if encoding is unsuccessful
Parameters: urlsafe bitset of characters deemed URL safe bytes array of bytes to convert to URL safe characters
Returns: array of bytes containing URL safe characters
Returns: the default string charset.
Deprecated: use #getDefaultCharset()
TheString
encoding used for decoding and encoding.
Returns: Returns the encoding.