org.apache.oodt.commons.io

Class Base64EncodingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.oodt.commons.io.Base64EncodingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class Base64EncodingOutputStream
extends FilterOutputStream

An output stream that encodes its data into RFC-1512 base 64 format. Wrap this input stream around another output stream, and all the bytes will be converted into their base-64 format when you write to it.

Author:

Kelly

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
Base64EncodingOutputStream(OutputStream outputStream) Construct a base-64 encoding output stream.

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream.
void	flush() Flush the stream.
void	write(byte[] b, int offset, int length) Write a bunch of bytes.
void	write(int b) Write a byte of data.

Methods inherited from class java.io.FilterOutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64EncodingOutputStream

public Base64EncodingOutputStream(OutputStream outputStream)

Construct a base-64 encoding output stream.

Parameters:

outputStream - The output stream to which to write.

Method Detail

write

public void write(int b)
           throws IOException

Write a byte of data. The byte will be encoded into base-64 format on the output.

Overrides:

write in class FilterOutputStream

Parameters:

b - The byte.

Throws:

IOException - If an I/O error occurs.

write

public void write(byte[] b,
                  int offset,
                  int length)
           throws IOException

Write a bunch of bytes. The given array of bytes will be encoded into base-64 on the output.

Overrides:

write in class FilterOutputStream

Parameters:

b - The array to write.

offset - Where in the data to start writing.

length - How many bytes to write.

Throws:

IOException - If an I/O error occurs.

flush

public void flush()
           throws IOException

Flush the stream. This causes any buffered bytes to be encoded and shipped out to the underlying stream, which is also flushed.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - If an I/O error occurs.

close

public void close()
           throws IOException

Close the stream. This writes out any unflushed data in base-64 format and closes the underlying stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException - If an I/O error occurs.