java.io
public class
public class
java.io.BufferedOutputStream
| java.lang.Object | ||||
| java.io.OutputStream | Closeable Flushable | |||
| java.io.FilterOutputStream | ||||
| java.io.BufferedOutputStream | ||||
BufferedOutputStream is a class which takes an output stream and buffers the writes to that stream. In this way, costly interaction with the original output stream can be minimized by writing buffered amounts of data infrequently. The drawback is that extra space is required to hold the buffer and copying takes place when writing that buffer.
See Also
Summary
Fields
| protected | byte[] | buf | The buffer containing the bytes to be written to the target OutputStream. | ||
| protected | int | count | The total number of bytes inside the byte array buf. |
Fields inherited
from class
java.io.FilterOutputStream
Public Constructors
| BufferedOutputStream(OutputStream out) | |||||
Constructs a new BufferedOutputStream on the OutputStream
out. |
|||||
| BufferedOutputStream(OutputStream out, int size) | |||||
Constructs a new BufferedOutputStream on the OutputStream
out. |
|||||
Public Methods
| synchronized | void | flush() | |||
| Flush this BufferedOutputStream to ensure all pending data is written out to the target OutputStream. | |||||
| synchronized | void | write(int oneByte) | |||
Writes the specified byte oneByte to this
BufferedOutputStream. |
|||||
| synchronized | void | write(byte[] buffer, int offset, int length) | |||
Writes count bytes from the byte array
buffer starting at offset to this
BufferedOutputStream. |
|||||
Methods inherited
from class
java.io.FilterOutputStream
Methods inherited
from class
java.io.OutputStream
Methods inherited
from class
java.lang.Object
Methods inherited
from interface
java.io.Flushable
Methods inherited
from interface
java.io.Closeable
Details
Fields
protected byte[] buf
The buffer containing the bytes to be written to the target OutputStream.
protected int count
The total number of bytes inside the byte array
buf.
Public Constructors
public BufferedOutputStream(OutputStream out)
Constructs a new BufferedOutputStream on the OutputStream
out. The default buffer size (8Kb) is allocated and all
writes are now filtered through this stream.
Parameters
| out | the OutputStream to buffer writes on. |
|---|
public BufferedOutputStream(OutputStream out, int size)
Constructs a new BufferedOutputStream on the OutputStream
out. The buffer size is set to size and
all writes are now filtered through this stream.
Parameters
| out | the OutputStream to buffer writes on. |
|---|---|
| size | the size of the buffer in bytes. |
Throws
| IllegalArgumentException | the size is <= 0 |
|---|
Public Methods
public synchronized void flush()
Flush this BufferedOutputStream to ensure all pending data is written out
to the target OutputStream. In addition, the target stream is also
flushed.
Throws
| IOException | If an error occurs attempting to flush this BufferedOutputStream. |
|---|
public synchronized void write(int oneByte)
Writes the specified byte
oneByte to this
BufferedOutputStream. Only the low order byte of oneByte
is written. If there is room in the buffer, the byte is copied in and the
count incremented. Otherwise, the buffer plus oneByte are
written to the target stream, the target is flushed, and the buffer is
reset.
Parameters
| oneByte | the byte to be written |
|---|
Throws
| IOException | If an error occurs attempting to write to this BufferedOutputStream. |
|---|
public synchronized void write(byte[] buffer, int offset, int length)
Writes
count bytes from the byte array
buffer starting at offset to this
BufferedOutputStream. If there is room in the buffer to hold the bytes,
they are copied in. If not, the buffered bytes plus the bytes in
buffer are written to the target stream, the target is
flushed, and the buffer is cleared.
Parameters
| buffer | the buffer to be written |
|---|---|
| offset | offset in buffer to get bytes |
| length | number of bytes in buffer to write |
Throws
| IOException | If an error occurs attempting to write to this BufferedOutputStream. |
|---|---|
| NullPointerException | If buffer is null. |
| ArrayIndexOutOfBoundsException | If offset or count is outside of bounds. |