Package edu.rit.io

Class LineBufferedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

edu.rit.io.LineBufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LineBufferedOutputStream
extends FilterOutputStream

Class LineBufferedOutputStream provides a line buffer layered on top of an underlying output stream. All writes to the line buffered output stream are accumulated in an internal buffer. Calling flush() on the line buffered output stream does nothing. The only times the internal buffer is flushed to the underlying output stream are when a newline byte ('\n') is written and when the line buffered output stream is closed.

Version:

19-Oct-2006

Author:

Alan Kaminsky

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
LineBufferedOutputStream(OutputStream out)	Construct a new line buffered output stream.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this line buffered output stream.
void	flush()	Flush this line buffered output stream.
void	write(byte[] buf)	Write the given byte array to this line buffered output stream.
void	write(byte[] buf, int off, int len)	Write a portion of the given byte array to this line buffered output stream.
void	write(int b)	Write the given byte to this line buffered output stream.

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

LineBufferedOutputStream

public LineBufferedOutputStream(OutputStream out)

Construct a new line buffered output stream.

Parameters:

out - Underlying output stream.

Method Details

write

public void write(int b)
           throws IOException

Write the given byte to this line buffered output stream. Only the least significant 8 bits of b are written.

Overrides:

write in class FilterOutputStream

Parameters:

b - Byte.

Throws:

IOException - Thrown if an I/O error occurred.

IOException - if any.

write

public void write(byte[] buf)
           throws IOException

Write the given byte array to this line buffered output stream.

Overrides:

write in class FilterOutputStream

Parameters:

buf - Byte array.

Throws:

NullPointerException - (unchecked exception) Thrown if buf is null.

IOException - Thrown if an I/O error occurred.

IOException - if any.

write

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

Write a portion of the given byte array to this line buffered output stream.

Overrides:

write in class FilterOutputStream

Throws:

NullPointerException - (unchecked exception) Thrown if buf is null.

IndexOutOfBoundsException - (unchecked exception) Thrown if off < 0, len < 0, or off+len > buf.length.

IOException - Thrown if an I/O error occurred.

flush

public void flush()
           throws IOException

Flush this line buffered output stream. The flush() method does nothing.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - Thrown if an I/O error occurred.

IOException - if any.

close

public void close()
           throws IOException

Close this line buffered output stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException - Thrown if an I/O error occurred.

IOException - if any.