org.apache.commons.codec.net

Class BCodec

java.lang.Object

org.apache.commons.codec.net.BCodec

All Implemented Interfaces:

Decoder, Encoder, StringDecoder, StringEncoder

Deprecated.

Please use URL.openConnection() instead. Please visit this webpage for further details.

@Deprecated
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.

Since:

1.3

See Also:

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

Constructor Summary

Constructors

Constructor and Description
BCodec() Deprecated. Default constructor.
BCodec(java.lang.String charset) Deprecated. Constructor which allows for the selection of a default charset

Method Summary

Modifier and Type	Method and Description
java.lang.Object	decode(java.lang.Object value) Deprecated. Decodes a Base64 object into its original form.
java.lang.String	decode(java.lang.String value) Deprecated. Decodes a Base64 string into its original form.
java.lang.Object	encode(java.lang.Object value) Deprecated. Encodes an object into its Base64 form using the default charset.
java.lang.String	encode(java.lang.String value) Deprecated. Encodes a string into its Base64 form using the default charset.
java.lang.String	encode(java.lang.String value, java.lang.String charset) Deprecated. Encodes a string into its Base64 form using the specified charset.
java.lang.String	getDefaultCharset() Deprecated. The default charset used for string decoding and encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

BCodec

public BCodec()

Deprecated.

Default constructor.

BCodec

public BCodec(java.lang.String charset)

Deprecated.

Constructor which allows for the selection of a default charset

Parameters:

charset - the default string charset to use.

See Also:

JRE character encoding names

Method Detail

encode

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

Deprecated.

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

Parameters:

value - string to convert to Base64 form

charset - the charset for pString

Returns:

Base64 string

Throws:

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

encode

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

Deprecated.

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

Specified by:

encode in interface StringEncoder

Parameters:

value - string to convert to Base64 form

Returns:

Base64 string

Throws:

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

decode

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

Deprecated.

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

Specified by:

decode in interface StringDecoder

Parameters:

value - Base64 string to convert into its original form

Returns:

original string

Throws:

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

Deprecated.

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

Specified by:

encode in interface Encoder

Parameters:

value - object to convert to Base64 form

Returns:

Base64 object

Throws:

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

decode

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

Deprecated.

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

Specified by:

decode in interface Decoder

Parameters:

value - Base64 object to convert into its original form

Returns:

original object

Throws:

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

getDefaultCharset

public java.lang.String getDefaultCharset()

Deprecated.

The default charset used for string decoding and encoding.

Returns:

the default string charset.