android.util

Class Base64OutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

android.util.Base64OutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class Base64OutputStream
extends FilterOutputStream

An OutputStream that does Base64 encoding on the data written to it, writing the resulting data to another OutputStream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
Base64OutputStream(OutputStream out, int options) Performs Base64 encoding on the data written to the stream, writing the encoded data to another OutputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Encodes and writes the remaining buffered bytes, adds necessary padding, and closes the output stream.
void	flush() Flushed the enclosed output stream, but does not write uncompleted 4-blocks.
void	write(int theByte) Writes the byte to the output stream after converting to/from Base64 notation.

Methods inherited from class java.io.FilterOutputStream

write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64OutputStream

public Base64OutputStream(OutputStream out,
                          int options)

Performs Base64 encoding on the data written to the stream, writing the encoded data to another OutputStream.

Parameters:

out - the OutputStream to write the encoded data to

options - bit flags for controlling the encoder; see the constants in Base64

Method Detail

write

public void write(int theByte)
           throws IOException

Writes the byte to the output stream after converting to/from Base64 notation. When encoding, bytes are buffered three at a time before the output stream actually gets a write() call. When decoding, bytes are buffered four at a time.

Overrides:

write in class FilterOutputStream

Parameters:

theByte - the byte to write

Throws:

IOException

flush

public void flush()
           throws IOException

Flushed the enclosed output stream, but does not write uncompleted 4-blocks. To ensure consistency that only happens on close.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Encodes and writes the remaining buffered bytes, adds necessary padding, and closes the output stream. Does nothing if the stream is already closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException - If unable to write the remaining bytes or close the stream.