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, encodeTextprivate 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()
RFC1522CodecgetEncoding in class RFC1522Codecprotected byte[] doEncoding(byte[] bytes)
RFC1522CodecdoEncoding in class RFC1522Codecbytes - Data to be encodedprotected byte[] doDecoding(byte[] bytes)
RFC1522CodecdoDecoding in class RFC1522Codecbytes - 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 valueEncoderException - 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 valueEncoderException - 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 StringEncodervalue - 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 StringDecodervalue - 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 Encodervalue - 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 Decodervalue - 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()
commons-codec version 1.10-SNAPSHOT - Copyright © 2002-2015 - Apache Software Foundation