com.phloc.commons.codec

Class RFC1522BCodec

java.lang.Object

com.phloc.commons.codec.AbstractCodec

com.phloc.commons.codec.AbstractRFC1522Codec

com.phloc.commons.codec.RFC1522BCodec

All Implemented Interfaces:

IByteArrayDecoder, IByteArrayEncoder, ICodec, IStringCodec, IDecoder<byte[]>, IEncoder<byte[]>

public class RFC1522BCodec
extends AbstractRFC1522Codec

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.

This class is immutable and thread-safe.

See Also:

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

Field Summary

Fields inherited from class com.phloc.commons.codec.AbstractRFC1522Codec

POSTFIX, PREFIX, SEP

Constructor Summary

Constructors

Constructor and Description
RFC1522BCodec() Default constructor with the UTF-8 charset.
RFC1522BCodec(Charset aCharset) Constructor which allows for the selection of a default charset

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(byte[] aEncodedBuffer) Decode a byte array.
String	decodeText(String sText) Decodes a Base64 string into its original form.
byte[]	encode(byte[] aDecodedBuffer) Encode a byte array.
String	encodeText(String sText) Encodes a string into its Base64 form using the default charset.
Charset	getCharset() Gets the default charset name used for string decoding and encoding.
protected String	getRFC1522Encoding() Returns the codec name (referred to as encoding in the RFC 1522).

Methods inherited from class com.phloc.commons.codec.AbstractRFC1522Codec

encodeText

Methods inherited from class com.phloc.commons.codec.AbstractCodec

decode, encode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.codec.ICodec

decode, encode

Constructor Detail

RFC1522BCodec

public RFC1522BCodec()

Default constructor with the UTF-8 charset.

RFC1522BCodec

public RFC1522BCodec(@Nonnull
             Charset aCharset)

Constructor which allows for the selection of a default charset

Parameters:

aCharset - the default string charset to use.

Method Detail

getRFC1522Encoding

protected String getRFC1522Encoding()

Description copied from class: AbstractRFC1522Codec

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

Specified by:

getRFC1522Encoding in class AbstractRFC1522Codec

Returns:

name of the codec

getCharset

@Nonnull
public Charset getCharset()

Description copied from interface: IStringCodec

Gets the default charset name used for string decoding and encoding.

Returns:

the default charset. Never null.

encode

@Nullable
public byte[] encode(@Nullable
                     byte[] aDecodedBuffer)

Description copied from interface: IByteArrayEncoder

Encode a byte array.

Parameters:

aDecodedBuffer - The byte array to be encoded. May be null.

Returns:

The encoded byte array or null if the parameter was null.

decode

@Nullable
public byte[] decode(@Nullable
                     byte[] aEncodedBuffer)

Description copied from interface: IByteArrayDecoder

Decode a byte array.

Parameters:

aEncodedBuffer - The byte array to be decoded. May not be null.

Returns:

The decoded byte array or null if the parameter was null.

encodeText

@Nullable
public String encodeText(@Nullable
                         String sText)
                  throws EncoderException

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

Parameters:

sText - string to convert to Base64 form

Returns:

Base64 string

Throws:

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

decodeText

@Nullable
public String decodeText(@Nullable
                         String sText)
                  throws DecoderException

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

Specified by:

decodeText in interface IStringCodec

Overrides:

decodeText in class AbstractRFC1522Codec

Parameters:

sText - 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.