Class BufferedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.BufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BufferedOutputStream
extends FilterOutputStream

The class implements a buffered output stream. By setting up such an output stream, an application can write bytes to the underlying output stream without necessarily causing a call to the underlying system for each byte written.

API Note:

Once wrapped in a BufferedOutputStream, the underlying OutputStream should not be used directly nor wrapped with another stream.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	buf	The internal buffer where data is stored.
protected int	count	The number of valid bytes in the buffer.

Fields declared in class FilterOutputStream

out

Modifier and Type	Field	Description
protected OutputStream	out	The underlying output stream to be filtered.

Constructor Summary

Constructors

Constructor	Description
BufferedOutputStream(OutputStream out)	Creates a new buffered output stream to write data to the specified underlying output stream.
BufferedOutputStream(OutputStream out, int size)	Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.

Method Summary

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

Methods declared in class FilterOutputStream

close, write

Modifier and Type	Method	Description
void	close()	Closes this output stream and releases any system resources associated with the stream.
void	write(byte[] b)	Writes b.length bytes to this output stream.

Methods declared in class OutputStream

nullOutputStream

Modifier and Type	Method	Description
static OutputStream	nullOutputStream()	Returns a new OutputStream which discards all bytes.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

buf

protected byte[] buf

The internal buffer where data is stored.

count

protected int count

The number of valid bytes in the buffer. This value is always in the range 0 through buf.length; elements buf[0] through buf[count-1] contain valid byte data.

Constructor Details

BufferedOutputStream

public BufferedOutputStream(OutputStream out)

Creates a new buffered output stream to write data to the specified underlying output stream.

Parameters:

out - the underlying output stream.

BufferedOutputStream

public BufferedOutputStream(OutputStream out,
 int size)

Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.

Parameters:

out - the underlying output stream.

size - the buffer size.

Throws:

IllegalArgumentException - if size <= 0.

Method Details

write

public void write(int b)
           throws IOException

Writes the specified byte to this buffered output stream.

Overrides:

write in class FilterOutputStream

Parameters:

b - the byte to be written.

Throws:

IOException - if an I/O error occurs.

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 buffered output stream.

Ordinarily this method stores bytes from the given array into this stream's buffer, flushing the buffer to the underlying output stream as needed. If the requested length is at least as large as this stream's buffer, however, then this method will flush the buffer and write the bytes directly to the underlying output stream. Thus redundant BufferedOutputStreams will not copy data unnecessarily.

Overrides:

write in class FilterOutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException - if an I/O error occurs.

IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

See Also:

• FilterOutputStream.write(int)

flush

public void flush()
           throws IOException

Flushes this buffered output stream. This forces any buffered output bytes to be written out to the underlying output stream.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

See Also:

• FilterOutputStream.out