|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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 | |
|---|---|
protected static String |
POSTFIX
Prefix |
protected static String |
PREFIX
Postfix |
protected static char |
SEP
Separator. |
| Constructor Summary | |
|---|---|
BCodec()
Default constructor. |
|
BCodec(String charset)
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 String |
decodeText(String text)
Applies an RFC 1522 compliant decoding scheme to the given string of text. |
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,
String charset)
Encodes a string into its Base64 form using the specified charset. |
protected String |
encodeText(String text,
String charset)
Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset. |
String |
getDefaultCharset()
The default charset 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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static final char SEP
protected static final String POSTFIX
protected static final String PREFIX
| Constructor Detail |
|---|
public BCodec()
public BCodec(String charset)
charset - the default string charset to use.| Method Detail |
|---|
protected String getEncoding()
protected byte[] doEncoding(byte[] bytes)
bytes - Data to be encoded
protected byte[] doDecoding(byte[] bytes)
bytes - Data to be decoded
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 StringEncodervalue - 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 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 Object encode(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 Object decode(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 String getDefaultCharset()
protected String encodeText(String text,
String charset)
throws EncoderException,
UnsupportedEncodingException
doEncoding(byte []) method of a concrete
class to perform the specific encoding.
text - a string to encodecharset - a charset to be used
EncoderException - thrown if there is an error condition during the Encoding
process.
UnsupportedEncodingException - thrown if charset is not supported
protected String decodeText(String text)
throws DecoderException,
UnsupportedEncodingException
doEncoding(byte []) method of a concrete class to perform the specific decoding.
text - a string to decode
null if the input is null.
DecoderException - thrown if there is an error condition during the decoding
process.
UnsupportedEncodingException - thrown if charset specified in the "encoded-word"
header is not supported
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||