org.apache.commons.codec.net
Class BCodec

java.lang.Object
  extended by org.apache.commons.codec.net.RFC1522Codec
      extended by org.apache.commons.codec.net.BCodec
All Implemented Interfaces:
Decoder, Encoder, StringDecoder, StringEncoder

public class BCodec
extends RFC1522Codec
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
Version:
$Id: BCodec.java 797857 2009-07-25 23:43:33Z ggregory $
Author:
Apache Software Foundation
See Also:
MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text

Field Summary
private  java.lang.String charset
          The default charset used for string decoding and encoding.
 
Fields inherited from class org.apache.commons.codec.net.RFC1522Codec
POSTFIX, PREFIX, SEP
 
Constructor Summary
BCodec()
          Default constructor.
BCodec(java.lang.String charset)
          Constructor which allows for the selection of a default charset
 
Method Summary
 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  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.
 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)
 
Methods inherited from class org.apache.commons.codec.net.RFC1522Codec
decodeText, encodeText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

charset

private final java.lang.String charset
The default charset used for string decoding and encoding.

Constructor Detail

BCodec

public BCodec()
Default constructor.


BCodec

public BCodec(java.lang.String charset)
Constructor which allows for the selection of a default charset

Parameters:
charset - the default string charset to use.
See Also:
Standard charsets
Method Detail

getEncoding

protected java.lang.String getEncoding()
Description copied from class: RFC1522Codec
Returns the codec name (referred to as encoding in the RFC 1522)

Specified by:
getEncoding in class RFC1522Codec
Returns:
name of the codec

doEncoding

protected byte[] doEncoding(byte[] bytes)
Description copied from class: RFC1522Codec
Encodes an array of bytes using the defined encoding scheme

Specified by:
doEncoding in class RFC1522Codec
Parameters:
bytes - Data to be encoded
Returns:
A byte array containing the encoded data

doDecoding

protected byte[] doDecoding(byte[] bytes)
Description copied from class: RFC1522Codec
Decodes an array of bytes using the defined encoding scheme

Specified by:
doDecoding in class RFC1522Codec
Parameters:
bytes - Data to be decoded
Returns:
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.

Parameters:
value - string to convert to Base64 form
charset - the charset for value
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
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
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
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
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 - 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.

Returns:
the default string charset.


commons-codec version 1.4 - Copyright © 2002-2015 - Apache Software Foundation