org.jaffre.io

Class AbstractByteBufferOutputStream

java.lang.Object

java.io.OutputStream

org.jaffre.io.AbstractByteBufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public abstract class AbstractByteBufferOutputStream
extends OutputStream

This is a helper class for writing adapters between classical java.io stream based output and java.nio based output.

Write operations are buffered in an internal java.nio.ByteBuffer. If this buffer gets full, or flush() or close() are being called, the method write(ByteBuffer, WRITE_MODE), that must be implemented by derived classes, is being called to consume pending data in the buffer.
Data not consumed by write(ByteBuffer, WRITE_MODE) will again be passed in subsequent write operations. So the implementor is responsible for avoiding infinite loops.

This class is not synchronized.

Author:

Alexander Veit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractByteBufferOutputStream.WRITE_MODE

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	m_buffer

Constructor Summary

Constructors

Constructor and Description
AbstractByteBufferOutputStream(ByteBuffer p_buffer)
AbstractByteBufferOutputStream(int p_iCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this output stream and forces any buffered output bytes to be written out.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] p_buf, int p_iOffs, int p_iLen)
abstract void	write(ByteBuffer p_buffer, AbstractByteBufferOutputStream.WRITE_MODE p_mode)
void	write(int p_iByte)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

m_buffer

protected ByteBuffer m_buffer

Constructor Detail

AbstractByteBufferOutputStream

public AbstractByteBufferOutputStream(int p_iCapacity)

AbstractByteBufferOutputStream

public AbstractByteBufferOutputStream(ByteBuffer p_buffer)

Method Detail

write

public void write(int p_iByte)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] p_buf,
         int p_iOffs,
         int p_iLen)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public abstract void write(ByteBuffer p_buffer,
         AbstractByteBufferOutputStream.WRITE_MODE p_mode)
                    throws IOException

Parameters:

p_buffer - The buffer that contains the data to be written.

p_mode -

• AbstractByteBufferOutputStream.WRITE_MODE.WRITE if this method was called by write(int), OutputStream.write(byte[]), or write(byte[], int, int), or
• AbstractByteBufferOutputStream.WRITE_MODE.FLUSH if this method was called by flush(), or
• AbstractByteBufferOutputStream.WRITE_MODE.CLOSE if this method was called by close().

Throws:

IOException - If an I/O error occurs.

flush

public void flush()
           throws IOException

Flushes this output stream and forces any buffered output bytes to be written out.

write(ByteBuffer, WRITE_MODE) will be called with AbstractByteBufferOutputStream.WRITE_MODE.FLUSH as second parameter.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException - If an I/O error occurred, or if the call to write(ByteBuffer, WRITE_MODE) did not consume all pending data.

close

public void close()
           throws IOException

Closes this output stream and forces any buffered output bytes to be written out.

write(ByteBuffer, WRITE_MODE) will be called with AbstractByteBufferOutputStream.WRITE_MODE.CLOSE as second parameter.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException - If an I/O error occurred, or if the call to write(ByteBuffer, WRITE_MODE) did not consume all pending data.