Package org.apache.axiom.util.base64

Class Base64EncodingWriterOutputStream

java.lang.Object

java.io.OutputStream

org.apache.axiom.util.base64.AbstractBase64EncodingOutputStream

org.apache.axiom.util.base64.Base64EncodingWriterOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class Base64EncodingWriterOutputStream
extends AbstractBase64EncodingOutputStream

OutputStream implementation that writes base64 encoded data to a Writer. This class internally buffers the data before writing it to the underlying stream.

Constructor Summary

Constructors

Constructor	Description
Base64EncodingWriterOutputStream(Writer writer)	Constructor that sets the buffer size to its default value of 4096 characters.
Base64EncodingWriterOutputStream(Writer writer, int bufferSize)	Constructor.
Base64EncodingWriterOutputStream(Writer writer, int bufferSize, boolean ignoreFlush)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doClose()	Close the underlying stream, if applicable.
protected void	doFlush()	Flush the underlying stream, if applicable.
protected void	doWrite(byte[] b)	Write base64 encoded data.
protected void	flushBuffer()	Write any pending data to the underlying stream, if applicable.

Methods inherited from class org.apache.axiom.util.base64.AbstractBase64EncodingOutputStream

close, complete, flush, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64EncodingWriterOutputStream

public Base64EncodingWriterOutputStream(Writer writer,
                                        int bufferSize,
                                        boolean ignoreFlush)

Constructor.

Parameters:

writer - the stream to write the encoded data to

bufferSize - the buffer size to use

ignoreFlush - specifies if calls to AbstractBase64EncodingOutputStream.flush() should be ignored; see AbstractBase64EncodingOutputStream(boolean) for more information

Base64EncodingWriterOutputStream

public Base64EncodingWriterOutputStream(Writer writer,
                                        int bufferSize)

Constructor.

Parameters:

writer - the stream to write the encoded data to

bufferSize - the buffer size to use

Base64EncodingWriterOutputStream

public Base64EncodingWriterOutputStream(Writer writer)

Constructor that sets the buffer size to its default value of 4096 characters.

Parameters:

writer - the stream to write the encoded data to

Method Detail

doWrite

protected void doWrite(byte[] b)
                throws IOException

Description copied from class: AbstractBase64EncodingOutputStream

Write base64 encoded data. If necessary, the implementation should accumulate the data in a buffer before writing it to the underlying stream.

Specified by:

doWrite in class AbstractBase64EncodingOutputStream

Parameters:

b - a byte array of length 4

Throws:

IOException - if an I/O error occurs

flushBuffer

protected void flushBuffer()
                    throws IOException

Description copied from class: AbstractBase64EncodingOutputStream

Write any pending data to the underlying stream, if applicable. Note that implementations should not flush the underlying stream.

Specified by:

flushBuffer in class AbstractBase64EncodingOutputStream

Throws:

IOException - if an I/O error occurs

doFlush

protected void doFlush()
                throws IOException

Description copied from class: AbstractBase64EncodingOutputStream

Flush the underlying stream, if applicable.

Specified by:

doFlush in class AbstractBase64EncodingOutputStream

Throws:

IOException - if an I/O error occurs

doClose

protected void doClose()
                throws IOException

Description copied from class: AbstractBase64EncodingOutputStream

Close the underlying stream, if applicable.

Specified by:

doClose in class AbstractBase64EncodingOutputStream

Throws:

IOException - if an I/O error occurs