org.apache.commons.codec.net
Class URLCodec

java.lang.Object
  extended byorg.apache.commons.codec.net.URLCodec
All Implemented Interfaces:
BinaryDecoder, BinaryEncoder, Decoder, Encoder, StringDecoder, StringEncoder

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 URLEncoder and 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,v 1.10 2003/11/08 01:52:25 ggregory Exp $
Author:
Oleg Kalnichevski, Gary Gregory

Field Summary
protected  String encoding
          The String encoding used for decoding and encoding.
protected static BitSet WWW_FORM_URL
          BitSet of www-form-url safe characters.
 
Constructor Summary
URLCodec()
          Default constructor.
URLCodec(String encoding)
          Constructor which allows for the selection of an Encoding
 
Method Summary
 byte[] decode(byte[] pArray)
          Decodes an array of URL safe 7-bit characters into an array of original bytes.
 Object decode(Object pObject)
          Decodes a URL safe object into its original form.
 String decode(String pString)
          Decodes a URL safe string into its original form.
 String decode(String pString, String charset)
          Decodes a URL safe string into its original form using the specified character set.
static byte[] decodeUrl(byte[] pArray)
          Decodes an array of URL safe 7-bit characters into an array of original bytes.
 byte[] encode(byte[] pArray)
          Encodes an array of bytes into an array of URL safe 7-bit characters.
 Object encode(Object pObject)
          Encodes an object into its URL safe form.
 String encode(String pString)
          Encodes a string into its URL safe form.
 String encode(String pString, String charset)
          Encodes a string into its URL safe form using the specified character set.
static byte[] encodeUrl(BitSet urlsafe, byte[] pArray)
          Encodes an array of bytes into an array of URL safe 7-bit characters.
 String getEncoding()
          The String encoding used for decoding and encoding.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

encoding

protected String encoding
The String encoding used for decoding and encoding.


WWW_FORM_URL

protected static final BitSet WWW_FORM_URL
BitSet of www-form-url safe characters.

Constructor Detail

URLCodec

public URLCodec()
Default constructor.


URLCodec

public URLCodec(String encoding)
Constructor which allows for the selection of an Encoding

Method Detail

encodeUrl

public static final byte[] encodeUrl(BitSet urlsafe,
                                     byte[] pArray)
Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.

Parameters:
urlsafe - bitset of characters deemed URL safe
pArray - array of bytes to convert to URL safe characters
Returns:
array of bytes containing URL safe characters

decodeUrl

public static final byte[] decodeUrl(byte[] pArray)
                              throws DecoderException
Decodes an array of URL safe 7-bit characters into an array of original bytes. Escaped characters are converted back to their original representation.

Parameters:
pArray - array of URL safe characters
Returns:
array of original bytes
Throws:
DecoderException - Thrown if URL decoding is unsuccessful

encode

public byte[] encode(byte[] pArray)
Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.

Specified by:
encode in interface BinaryEncoder
Parameters:
pArray - array of bytes to convert to URL safe characters
Returns:
array of bytes containing URL safe characters

decode

public byte[] decode(byte[] pArray)
              throws DecoderException
Decodes an array of URL safe 7-bit characters into an array of original bytes. Escaped characters are converted back to their original representation.

Specified by:
decode in interface BinaryDecoder
Parameters:
pArray - array of URL safe characters
Returns:
array of original bytes
Throws:
DecoderException - Thrown if URL decoding is unsuccessful

encode

public String encode(String pString,
                     String charset)
              throws UnsupportedEncodingException
Encodes a string into its URL safe form using the specified character set. Unsafe characters are escaped.

Parameters:
pString - string to convert to a URL safe form
Returns:
URL safe string
Throws:
UnsupportedEncodingException - Thrown if charset is not supported

encode

public String encode(String pString)
              throws EncoderException
Encodes a string into its URL safe form. Unsafe characters are escaped.

Specified by:
encode in interface StringEncoder
Parameters:
pString - string to convert to a URL safe form
Returns:
URL safe string
Throws:
EncoderException - Thrown if URL encoding is unsuccessful

decode

public String decode(String pString,
                     String charset)
              throws DecoderException,
                     UnsupportedEncodingException
Decodes a URL safe string into its original form using the specified character set. Escaped characters are converted back to their original representation.

Parameters:
pString - URL safe string to convert into its original form
Returns:
original string
Throws:
DecoderException - Thrown if URL decoding is unsuccessful
UnsupportedEncodingException - Thrown if charset is not supported

decode

public String decode(String pString)
              throws DecoderException
Decodes a URL safe string into its original form. Escaped characters are converted back to their original representation.

Specified by:
decode in interface StringDecoder
Parameters:
pString - URL safe string to convert into its original form
Returns:
original string
Throws:
DecoderException - Thrown if URL decoding is unsuccessful

encode

public Object encode(Object pObject)
              throws EncoderException
Encodes an object into its URL safe form. Unsafe characters are escaped.

Specified by:
encode in interface Encoder
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

decode

public Object decode(Object pObject)
              throws DecoderException
Decodes a URL safe object into its original form. Escaped characters are converted back to their original representation.

Specified by:
decode in interface Decoder
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

getEncoding

public String getEncoding()
The String encoding used for decoding and encoding.

Returns:
Returns the encoding.


${component.name} version 1.2 - Copyright © 2003 - Apache Software Foundation