depends.org.apache.commons.codec.net

类 BCodec

java.lang.Object

depends.org.apache.commons.codec.net.BCodec

所有已实现的接口:

Decoder, Encoder, StringDecoder, StringEncoder

public class BCodec
extends java.lang.Object
implements StringEncoder, StringDecoder

Identical to the Base64 encoding defined by RFC 1521 and allows a character set to be specified.

RFC 1522 describes techniques to allow the encoding of non-ASCII text in various portions of a RFC 822 [2] message header, in a manner which is unlikely to confuse existing message handling software.

从以下版本开始:

1.3

另请参阅:

MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	POSTFIX Prefix
protected static java.lang.String	PREFIX Postfix
protected static char	SEP Separator.

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	decode(java.lang.Object value) Decodes a Base64 object into its original form.
java.lang.String	decode(java.lang.String value) Decodes a Base64 string into its original form.
protected java.lang.String	decodeText(java.lang.String text) Applies an RFC 1522 compliant decoding scheme to the given string of text.
protected byte[]	doDecoding(byte[] bytes) Decodes an array of bytes using the defined encoding scheme
protected byte[]	doEncoding(byte[] bytes) Encodes an array of bytes using the defined encoding scheme
java.lang.Object	encode(java.lang.Object value) Encodes an object into its Base64 form using the default charset.
java.lang.String	encode(java.lang.String value) Encodes a string into its Base64 form using the default charset.
java.lang.String	encode(java.lang.String value, java.lang.String charset) Encodes a string into its Base64 form using the specified charset.
protected java.lang.String	encodeText(java.lang.String text, java.lang.String charset) Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset.
java.lang.String	getDefaultCharset() The default charset used for string decoding and encoding.
protected java.lang.String	getEncoding() Returns the codec name (referred to as encoding in the RFC 1522)

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

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

字段详细资料

SEP

protected static final char SEP

Separator.

另请参阅:

常量字段值

POSTFIX

protected static final java.lang.String POSTFIX

Prefix

另请参阅:

常量字段值

PREFIX

protected static final java.lang.String PREFIX

Postfix

另请参阅:

常量字段值

构造器详细资料

BCodec

public BCodec()

Default constructor.

BCodec

public BCodec(java.lang.String charset)

Constructor which allows for the selection of a default charset

参数:

charset - the default string charset to use.

另请参阅:

Standard charsets

方法详细资料

getEncoding

protected java.lang.String getEncoding()

Returns the codec name (referred to as encoding in the RFC 1522)

返回:

name of the codec

doEncoding

protected byte[] doEncoding(byte[] bytes)

Encodes an array of bytes using the defined encoding scheme

参数:

bytes - Data to be encoded

返回:

A byte array containing the encoded data

doDecoding

protected byte[] doDecoding(byte[] bytes)

Decodes an array of bytes using the defined encoding scheme

参数:

bytes - Data to be decoded

返回:

a byte array that contains decoded data

encode

public java.lang.String encode(java.lang.String value,
                      java.lang.String charset)
                        throws EncoderException

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

参数:

value - string to convert to Base64 form

charset - the charset for value

返回:

Base64 string

抛出:

EncoderException - thrown if a failure condition is encountered during the encoding process.

encode

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

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

指定者:

encode 在接口中 StringEncoder

参数:

value - string to convert to Base64 form

返回:

Base64 string

抛出:

EncoderException - thrown if a failure condition is encountered during the encoding process.

decode

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

Decodes a Base64 string into its original form. Escaped characters are converted back to their original representation.

指定者:

decode 在接口中 StringDecoder

参数:

value - Base64 string to convert into its original form

返回:

original string

抛出:

DecoderException - A decoder exception is thrown if a failure condition is encountered during the decode process.

encode

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

Encodes an object into its Base64 form using the default charset. Unsafe characters are escaped.

指定者:

encode 在接口中 Encoder

参数:

value - object to convert to Base64 form

返回:

Base64 object

抛出:

EncoderException - thrown if a failure condition is encountered during the encoding process.

decode

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

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

指定者:

decode 在接口中 Decoder

参数:

value - Base64 object to convert into its original form

返回:

original object

抛出:

DecoderException - Thrown if the argument is not a String. 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.

encodeText

protected java.lang.String encodeText(java.lang.String text,
                          java.lang.String charset)
                               throws EncoderException,
                                      java.io.UnsupportedEncodingException

Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset. This method constructs the "encoded-word" header common to all the RFC 1522 codecs and then invokes doEncoding(byte []) method of a concrete class to perform the specific encoding.

参数:

text - a string to encode

charset - a charset to be used

返回:

RFC 1522 compliant "encoded-word"

抛出:

EncoderException - thrown if there is an error condition during the Encoding process.

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

另请参阅:

Standard charsets

decodeText

protected java.lang.String decodeText(java.lang.String text)
                               throws DecoderException,
                                      java.io.UnsupportedEncodingException

Applies an RFC 1522 compliant decoding scheme to the given string of text. This method processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes doEncoding(byte []) method of a concrete class to perform the specific decoding.

参数:

text - a string to decode

返回:

A new decoded String or null if the input is null.

抛出:

DecoderException - thrown if there is an error condition during the decoding process.

java.io.UnsupportedEncodingException - thrown if charset specified in the "encoded-word" header is not supported