edu.illinois.cs.cogcomp.lbjava.io

Class ChannelOutputStream

java.lang.Object

java.io.OutputStream

edu.illinois.cs.cogcomp.lbjava.io.ChannelOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ChannelOutputStream
extends OutputStream

This class implements an output stream that buffers output in a directly allocated ByteBuffer before writing it to a channel.

Author:

Nick Rizzolo

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	buffer Holds data until it is written.
protected WritableByteChannel	channel The channel where the data will be written.

Constructor Summary

Constructors

Constructor and Description
ChannelOutputStream(WritableByteChannel out) Creates the stream from the channel where the data will be written.
ChannelOutputStream(WritableByteChannel out, int size) Creates the stream from the channel where the data will be written and a buffer size.

Method Summary

Modifier and Type	Method and Description
void	close() Flushes the buffer and closes the channel.
void	flush() Forces any buffered output bytes to be written to channel.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this channel output stream.
void	write(int b) Writes the specified byte to this channel output stream.

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

buffer

protected ByteBuffer buffer

Holds data until it is written.

channel

protected WritableByteChannel channel

The channel where the data will be written.

Constructor Detail

ChannelOutputStream

public ChannelOutputStream(WritableByteChannel out)

Creates the stream from the channel where the data will be written.

Parameters:

out - The channel where the data will be written.

ChannelOutputStream

public ChannelOutputStream(WritableByteChannel out,
                           int size)

Creates the stream from the channel where the data will be written and a buffer size.

Parameters:

out - The channel where the data will be written.

size - The buffer size.

Method Detail

write

public void write(int b)
           throws IOException

Writes the specified byte to this channel output stream.

Specified by:

write in class OutputStream

Parameters:

b - The byte to be written.

Throws:

IOException - Possible while flush()ing.

write

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

Writes len bytes from the specified byte array starting at offset off to this channel output stream.

Overrides:

write in class OutputStream

Parameters:

b - The data.

off - The start offset in the data.

len - The number of bytes to write.

Throws:

IOException - Possible while flush()ing.

flush

public void flush()
           throws IOException

Forces any buffered output bytes to be written to channel.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException - Possible while writing to channel.

close

public void close()
           throws IOException

Flushes the buffer and closes the channel.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException - Possible while closing channel.