org.w3c.tools.codec

Class Base64Decoder

java.lang.Object

org.w3c.tools.codec.Base64Decoder

public class Base64Decoder
extends java.lang.Object

Decode a BASE64 encoded input stream to some output stream. This class implements BASE64 decoding, as specified in the MIME specification.

Since:

May 17, 2013 (Lei Wang) Add methods to decode a string to bytes/object.

Author:

w3c

See Also:

Base64Encoder

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.io.InputStream	in
(package private) java.io.OutputStream	out
(package private) boolean	stringp

Constructor Summary

Constructors

Constructor and Description
Base64Decoder(java.io.InputStream in, java.io.OutputStream out) Create a decoder to decode a stream.
Base64Decoder(java.lang.String input) Create a decoder to decode a String.

Method Summary

Modifier and Type	Method and Description
static byte[]	decodeBase64Bytes(java.lang.String base64String) Decode a base64 encoded string to array of bytes with a default charset .
static byte[]	decodeBase64Bytes(java.lang.String base64String, java.lang.String charset) Decode a base64 encoded string to array of bytes with a charset.
static java.lang.Object	decodeBase64Object(java.lang.String base64String) Decode a base64 encoded string to an object with a default charset .
static java.lang.Object	decodeBase64Object(java.lang.String base64String, java.lang.String charset) Decode a base64 encoded string to an object with a charset.
static void	main(java.lang.String[] args) Test the decoder.
void	process() Do the actual decoding.
java.lang.String	processString() Do the decoding, and return a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

in

java.io.InputStream in

out

java.io.OutputStream out

stringp

boolean stringp

Constructor Detail

Base64Decoder

public Base64Decoder(java.lang.String input)

Create a decoder to decode a String.

Parameters:

input - The string to be decoded.

Base64Decoder

public Base64Decoder(java.io.InputStream in,
                     java.io.OutputStream out)

Create a decoder to decode a stream.

Parameters:

in - The input stream (to be decoded).

out - The output stream, to write decoded data to.

Method Detail

process

public void process()
             throws java.io.IOException,
                    Base64FormatException

Do the actual decoding. Process the input stream by decoding it and emiting the resulting bytes into the output stream.

Throws:

java.io.IOException - If the input or output stream accesses failed.

Base64FormatException - If the input stream is not compliant with the BASE64 specification.

processString

public java.lang.String processString()
                               throws Base64FormatException

Do the decoding, and return a String. This methods should be called when the decoder is used in String mode. It decodes the input string to an output string that is returned.

Throws:

java.lang.RuntimeException - If the object wasn't constructed to decode a String.

Base64FormatException - If the input string is not compliant with the BASE64 specification.

decodeBase64Bytes

public static byte[] decodeBase64Bytes(java.lang.String base64String)
                                throws java.lang.IllegalThreadStateException

Decode a base64 encoded string to array of bytes with a default charset .

Parameters:

base64String, - a base64 encoded string

Returns:

the decoded bytes

Throws:

java.lang.IllegalThreadStateException

decodeBase64Bytes

public static byte[] decodeBase64Bytes(java.lang.String base64String,
                                       java.lang.String charset)
                                throws java.lang.IllegalThreadStateException

Decode a base64 encoded string to array of bytes with a charset.

Parameters:

base64String, - a base64 encoded string

charset, - charset used to translate string to bytes.

Returns:

Throws:

java.lang.IllegalThreadStateException

decodeBase64Object

public static java.lang.Object decodeBase64Object(java.lang.String base64String)
                                           throws java.lang.IllegalThreadStateException

Decode a base64 encoded string to an object with a default charset .

Parameters:

base64String, - a base64 encoded string, representing a Serializable object

Returns:

Throws:

java.lang.IllegalThreadStateException

decodeBase64Object

public static java.lang.Object decodeBase64Object(java.lang.String base64String,
                                                  java.lang.String charset)
                                           throws java.lang.IllegalThreadStateException

Decode a base64 encoded string to an object with a charset.

Parameters:

base64String, - a base64 encoded string, representing a Serializable object

charset, - charset used to translate string to bytes.

Returns:

Throws:

java.lang.IllegalThreadStateException

main

public static void main(java.lang.String[] args)

Test the decoder. Run it with one argument: the string to be decoded, it will print out the decoded value.