|
||||||||||
| 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.
| 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 |
|---|
private final java.lang.String charset
| Constructor Detail |
|---|
public BCodec()
public BCodec(java.lang.String charset)
charset - the default string charset to use.| Method Detail |
|---|
protected java.lang.String getEncoding()
RFC1522Codec
getEncoding in class RFC1522Codecprotected byte[] doEncoding(byte[] bytes)
RFC1522Codec
doEncoding in class RFC1522Codecbytes - Data to be encoded
protected byte[] doDecoding(byte[] bytes)
RFC1522Codec
doDecoding in class RFC1522Codecbytes - Data to be decoded
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 StringEncodervalue - string to convert to Base64 form
EncoderException - 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 form
DecoderException - 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 form
EncoderException - 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 form
DecoderException - Thrown if the argument is not a String. Thrown if a failure condition is
encountered during the decode process.public java.lang.String getDefaultCharset()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||