depends.org.apache.commons.codec.net

类 URLCodec

java.lang.Object

depends.org.apache.commons.codec.net.URLCodec

所有已实现的接口:

BinaryDecoder, BinaryEncoder, Decoder, Encoder, StringDecoder, StringEncoder

public class URLCodec
extends java.lang.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.

从以下版本开始:

1.2

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	charset The default charset used for string decoding and encoding.
protected static byte	ESCAPE_CHAR Release 1.5 made this field final.
protected static java.util.BitSet	WWW_FORM_URL BitSet of www-form-url safe characters.

构造器概要

构造器

构造器和说明
URLCodec() Default constructor.
URLCodec(java.lang.String charset) Constructor which allows for the selection of a default charset

方法概要

方法

限定符和类型	方法和说明
byte[]	decode(byte[] bytes) Decodes an array of URL safe 7-bit characters into an array of original bytes.
java.lang.Object	decode(java.lang.Object pObject) Decodes a URL safe object into its original form.
java.lang.String	decode(java.lang.String pString) Decodes a URL safe string into its original form using the default string charset.
java.lang.String	decode(java.lang.String pString, java.lang.String charset) Decodes a URL safe string into its original form using the specified encoding.
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.
java.lang.Object	encode(java.lang.Object pObject) Encodes an object into its URL safe form.
java.lang.String	encode(java.lang.String pString) Encodes a string into its URL safe form using the default string charset.
java.lang.String	encode(java.lang.String pString, java.lang.String charset) Encodes a string into its URL safe form using the specified string charset.
static byte[]	encodeUrl(java.util.BitSet urlsafe, byte[] bytes) Encodes an array of bytes into an array of URL safe 7-bit characters.
java.lang.String	getDefaultCharset() The default charset used for string decoding and encoding.
java.lang.String	getEncoding() 已过时。 Use getDefaultCharset(), will be removed in 2.0.

从类继承的方法 java.lang.Object

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

字段详细资料

charset

protected java.lang.String charset

The default charset used for string decoding and encoding. TODO: This field will be final in 2.0.

ESCAPE_CHAR

protected static final byte ESCAPE_CHAR

Release 1.5 made this field final.

另请参阅:

常量字段值

WWW_FORM_URL

protected static final java.util.BitSet WWW_FORM_URL

BitSet of www-form-url safe characters.

构造器详细资料

URLCodec

public URLCodec()

Default constructor.

URLCodec

public URLCodec(java.lang.String charset)

Constructor which allows for the selection of a default charset

参数:

charset - the default string charset to use.

方法详细资料

encodeUrl

public static final byte[] encodeUrl(java.util.BitSet urlsafe,
               byte[] bytes)

Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.

参数:

urlsafe - bitset of characters deemed URL safe

bytes - array of bytes to convert to URL safe characters

返回:

array of bytes containing URL safe characters

decodeUrl

public static final byte[] decodeUrl(byte[] bytes)
                              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.

参数:

bytes - array of URL safe characters

返回:

array of original bytes

抛出:

DecoderException - Thrown if URL decoding is unsuccessful

encode

public byte[] encode(byte[] bytes)

Encodes an array of bytes into an array of URL safe 7-bit characters. Unsafe characters are escaped.

指定者:

encode 在接口中 BinaryEncoder

参数:

bytes - array of bytes to convert to URL safe characters

返回:

array of bytes containing URL safe characters

decode

public byte[] decode(byte[] bytes)
              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.

指定者:

decode 在接口中 BinaryDecoder

参数:

bytes - array of URL safe characters

返回:

array of original bytes

抛出:

DecoderException - Thrown if URL decoding is unsuccessful

encode

public java.lang.String encode(java.lang.String pString,
                      java.lang.String charset)
                        throws java.io.UnsupportedEncodingException

Encodes a string into its URL safe form using the specified string charset. Unsafe characters are escaped.

参数:

pString - string to convert to a URL safe form

charset - the charset for pString

返回:

URL safe string

抛出:

java.io.UnsupportedEncodingException - Thrown if charset is not supported

encode

public java.lang.String encode(java.lang.String pString)
                        throws EncoderException

Encodes a string into its URL safe form using the default string charset. Unsafe characters are escaped.

指定者:

encode 在接口中 StringEncoder

参数:

pString - string to convert to a URL safe form

返回:

URL safe string

抛出:

EncoderException - Thrown if URL encoding is unsuccessful

另请参阅:

getDefaultCharset()

decode

public java.lang.String decode(java.lang.String pString,
                      java.lang.String charset)
                        throws DecoderException,
                               java.io.UnsupportedEncodingException

Decodes a URL safe string into its original form using the specified encoding. Escaped characters are converted back to their original representation.

参数:

pString - URL safe string to convert into its original form

charset - the original string charset

返回:

original string

抛出:

DecoderException - Thrown if URL decoding is unsuccessful

java.io.UnsupportedEncodingException - Thrown if charset is not supported

decode

public java.lang.String decode(java.lang.String pString)
                        throws DecoderException

Decodes a URL safe string into its original form using the default string charset. Escaped characters are converted back to their original representation.

指定者:

decode 在接口中 StringDecoder

参数:

pString - URL safe string to convert into its original form

返回:

original string

抛出:

DecoderException - Thrown if URL decoding is unsuccessful

另请参阅:

getDefaultCharset()

encode

public java.lang.Object encode(java.lang.Object pObject)
                        throws EncoderException

Encodes an object into its URL safe form. Unsafe characters are escaped.

指定者:

encode 在接口中 Encoder

参数:

pObject - string to convert to a URL safe form

返回:

URL safe object

抛出:

EncoderException - Thrown if URL encoding is not applicable to objects of this category or if encoding is unsuccessful

decode

public java.lang.Object decode(java.lang.Object pObject)
                        throws DecoderException

Decodes a URL safe object into its original form. Escaped characters are converted back to their original representation.

指定者:

decode 在接口中 Decoder

参数:

pObject - URL safe object to convert into its original form

返回:

original object

抛出:

DecoderException - Thrown if the argument is not a String or byte[]. Thrown if a failure condition is encountered during the decode process.

getDefaultCharset

public java.lang.String getDefaultCharset()

The default charset used for string decoding and encoding.

返回:

the default string charset.

getEncoding

public java.lang.String getEncoding()

已过时。 Use getDefaultCharset(), will be removed in 2.0.

The String encoding used for decoding and encoding.

返回:

Returns the encoding.