org.w3c.tools.codec

Class Base64Encoder

java.lang.Object

org.w3c.tools.codec.Base64Encoder

public class Base64Encoder
extends java.lang.Object

BASE64 encoder implementation. This object takes as parameter an input stream and an output stream. It encodes the input stream, using the BASE64 encoding rules, as defined in MIME specification and emit the resulting data to the output stream.

Since:

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

Author:

w3c

See Also:

Base64Decoder

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
static java.lang.String	UTF8_CHARSET

Constructor Summary

Constructors

Constructor and Description
Base64Encoder(java.io.InputStream in, java.io.OutputStream out) Create a new Base64 encoder, encoding input to output.
Base64Encoder(java.lang.String input) Create a new Base64 encoder, to encode the given string.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeBase64Bytes(byte[] bytes) Encode an array of bytes to a string with a default charset "UTF-8".
static java.lang.String	encodeBase64Bytes(byte[] bytes, java.lang.String charset) Encode an array of bytes to a string with a charset.
static java.lang.String	encodeBase64Object(java.lang.Object object) Encode an object to a string with a default charset "UTF-8".
static java.lang.String	encodeBase64Object(java.lang.Object object, java.lang.String charset) Encode an object to a string with a charset.
static void	main(java.lang.String[] args) Testing the encoder.
void	process() Process the data: encode the input stream to the output stream.
java.lang.String	processString() Encode the content of this encoder, as a string.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8_CHARSET

public static final java.lang.String UTF8_CHARSET

See Also:

Constant Field Values

in

java.io.InputStream in

out

java.io.OutputStream out

stringp

boolean stringp

Constructor Detail

Base64Encoder

public Base64Encoder(java.lang.String input)

Create a new Base64 encoder, to encode the given string.

Parameters:

input - The String to be encoded.

Base64Encoder

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

Create a new Base64 encoder, encoding input to output.

Parameters:

in - The input stream to be encoded.

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

Method Detail

process

public void process()
             throws java.io.IOException

Process the data: encode the input stream to the output stream. This method runs through the input stream, encoding it to the output stream.

Throws:

java.io.IOException - If we weren't able to access the input stream or the output stream.

processString

public java.lang.String processString()

Encode the content of this encoder, as a string. This methods encode the String content, that was provided at creation time, following the BASE64 rules, as specified in the rfc1521.

Returns:

A String, reprenting the encoded content of the input String.

encodeBase64Bytes

public static java.lang.String encodeBase64Bytes(byte[] bytes)
                                          throws java.lang.IllegalThreadStateException

Encode an array of bytes to a string with a default charset "UTF-8".

Parameters:

bytes - the bytes to be converted.

Returns:

Throws:

java.lang.IllegalThreadStateException

encodeBase64Bytes

public static java.lang.String encodeBase64Bytes(byte[] bytes,
                                                 java.lang.String charset)
                                          throws java.lang.IllegalThreadStateException

Encode an array of bytes to a string with a charset.

Parameters:

bytes - the bytes to be converted.

charset - the charset used to translate the bytes to string

Returns:

Throws:

java.lang.IllegalThreadStateException

encodeBase64Object

public static java.lang.String encodeBase64Object(java.lang.Object object)
                                           throws java.lang.IllegalThreadStateException

Encode an object to a string with a default charset "UTF-8".

Parameters:

object - the object to be encoded, must be Serializable

Returns:

Throws:

java.lang.IllegalThreadStateException

encodeBase64Object

public static java.lang.String encodeBase64Object(java.lang.Object object,
                                                  java.lang.String charset)
                                           throws java.lang.IllegalThreadStateException

Encode an object to a string with a charset.

Parameters:

object - the object to be encoded, must be Serializable

charset - the charset used to translate the object's bytes to string

Returns:

Throws:

java.lang.IllegalThreadStateException

main

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

Testing the encoder. Run with one argument, prints the encoded version of it.