net.sf.kdgcommons.buffer

Class ByteBufferOutputStream

java.lang.Object

java.io.OutputStream

net.sf.kdgcommons.buffer.ByteBufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ByteBufferOutputStream
extends OutputStream

An OutputStream that writes to an existing ByteBuffer. The buffer is repositioned at construction, and written sequentially. Attempts to write past the capacity of the buffer will result in IOException.

Warnings: Because this class explicitly repositions the buffer, you should not create two instances around the same buffer; slice() the buffer instead. Instances of this class are only as thread-safe as the underlying buffer (and the JavaDocs don't have much to say about that).

Constructor Summary

Constructors

Constructor and Description
ByteBufferOutputStream(ByteBuffer buf) Creates an instance that repositions the passed buffer to its start.
ByteBufferOutputStream(ByteBuffer buf, int index) Creates an instance that repositions the passed buffer to the specified index.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBufferOutputStream

public ByteBufferOutputStream(ByteBuffer buf)

Creates an instance that repositions the passed buffer to its start.

ByteBufferOutputStream

public ByteBufferOutputStream(ByteBuffer buf,
                              int index)

Creates an instance that repositions the passed buffer to the specified index.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException