public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder
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.
Modifier and Type | Field and Description |
---|---|
private java.nio.charset.Charset |
charset
The default charset used for string decoding and encoding.
|
POSTFIX, PREFIX, SEP
Constructor and Description |
---|
BCodec()
Default constructor.
|
BCodec(java.nio.charset.Charset charset)
Constructor which allows for the selection of a default charset
|
BCodec(java.lang.String charsetName)
Constructor which allows for the selection of a default charset
|
Modifier and Type | Method and Description |
---|---|
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.nio.charset.Charset charset)
Encodes a string into its Base64 form using the specified 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.nio.charset.Charset |
getCharset()
Gets the default charset name used for string decoding and encoding.
|
java.lang.String |
getDefaultCharset()
Gets the default charset name used for string decoding and encoding.
|
protected java.lang.String |
getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522).
|
decodeText, encodeText, encodeText
private final java.nio.charset.Charset charset
public BCodec()
public BCodec(java.nio.charset.Charset charset)
charset
- the default string charset to use.public BCodec(java.lang.String charsetName)
charsetName
- the default charset to use.java.nio.charset.UnsupportedCharsetException
- If the named charset is unavailableprotected java.lang.String getEncoding()
RFC1522Codec
getEncoding
in class RFC1522Codec
protected byte[] doEncoding(byte[] bytes)
RFC1522Codec
doEncoding
in class RFC1522Codec
bytes
- Data to be encodedprotected byte[] doDecoding(byte[] bytes)
RFC1522Codec
doDecoding
in class RFC1522Codec
bytes
- Data to be decodedpublic java.lang.String encode(java.lang.String value, java.nio.charset.Charset charset) throws EncoderException
value
- string to convert to Base64 formcharset
- the charset for value
EncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.String encode(java.lang.String value, java.lang.String charset) throws EncoderException
value
- string to convert to Base64 formcharset
- the charset for value
EncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.String encode(java.lang.String value) throws EncoderException
encode
in interface StringEncoder
value
- string to convert to Base64 formEncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.String decode(java.lang.String value) throws DecoderException
decode
in interface StringDecoder
value
- Base64 string to convert into its original formDecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.public java.lang.Object encode(java.lang.Object value) throws EncoderException
encode
in interface Encoder
value
- object to convert to Base64 formEncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.Object decode(java.lang.Object value) throws DecoderException
decode
in interface Decoder
value
- Base64 object to convert into its original formDecoderException
- Thrown if the argument is not a String
. Thrown if a failure condition is encountered
during the decode process.public java.nio.charset.Charset getCharset()
public java.lang.String getDefaultCharset()