|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.codec.net.RFC1522Codec
org.apache.commons.codec.net.BCodec
public class BCodec
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.
Field Summary | |
---|---|
private Charset |
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(Charset charset)
Constructor which allows for the selection of a default charset |
|
BCodec(String charsetName)
Constructor which allows for the selection of a default charset |
Method Summary | |
---|---|
Object |
decode(Object value)
Decodes a Base64 object into its original form. |
String |
decode(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. |
Object |
encode(Object value)
Encodes an object into its Base64 form using the default charset. |
String |
encode(String value)
Encodes a string into its Base64 form using the default charset. |
String |
encode(String value,
Charset charset)
Encodes a string into its Base64 form using the specified charset. |
String |
encode(String value,
String charset)
Encodes a string into its Base64 form using the specified charset. |
Charset |
getCharset()
Gets the default charset name used for string decoding and encoding. |
String |
getDefaultCharset()
Gets the default charset name used for string decoding and encoding. |
protected 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, encodeText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final Charset charset
Constructor Detail |
---|
public BCodec()
public BCodec(Charset charset)
charset
- the default string charset to use.public BCodec(String charsetName)
charsetName
- the default charset to use.
UnsupportedCharsetException
- If the named charset is unavailableMethod Detail |
---|
protected String getEncoding()
RFC1522Codec
getEncoding
in class RFC1522Codec
protected byte[] doEncoding(byte[] bytes)
RFC1522Codec
doEncoding
in class RFC1522Codec
bytes
- Data to be encoded
protected byte[] doDecoding(byte[] bytes)
RFC1522Codec
doDecoding
in class RFC1522Codec
bytes
- Data to be decoded
public String encode(String value, 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 String encode(String value, 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 String encode(String value) throws EncoderException
encode
in interface StringEncoder
value
- string to convert to Base64 form
EncoderException
- thrown if a failure condition is encountered during the encoding process.public String decode(String value) throws DecoderException
decode
in interface StringDecoder
value
- Base64 string to convert into its original form
DecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.public Object encode(Object value) throws EncoderException
encode
in interface Encoder
value
- object to convert to Base64 form
EncoderException
- thrown if a failure condition is encountered during the encoding process.public Object decode(Object value) throws DecoderException
decode
in interface Decoder
value
- Base64 object to convert into its original form
DecoderException
- Thrown if the argument is not a String
. Thrown if a failure condition is encountered
during the decode process.public Charset getCharset()
public String getDefaultCharset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |