java.io
Class BufferedOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.FilterOutputStream
          extended by java.io.BufferedOutputStream
All Implemented Interfaces:
Closeable, Flushable

public class BufferedOutputStream
extends FilterOutputStream

This class accumulates bytes written in a buffer instead of immediately writing the data to the underlying output sink. The bytes are instead as one large block when the buffer is filled, or when the stream is closed or explicitly flushed. This mode operation can provide a more efficient mechanism for writing versus doing numerous small unbuffered writes.


Field Summary
protected  byte[] buf
          This is the internal byte array used for buffering output before writing it.
protected  int count
          This is the number of bytes that are currently in the buffer and are waiting to be written to the underlying stream.
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
BufferedOutputStream(OutputStream out)
          This method initializes a new BufferedOutputStream instance that will write to the specified subordinate OutputStream and which will use a default buffer size of 512 bytes.
BufferedOutputStream(OutputStream out, int size)
          This method initializes a new BufferedOutputStream instance that will write to the specified subordinate OutputStream and which will use the specified buffer size
 
Method Summary
 void flush()
          This method causes any currently buffered bytes to be immediately written to the underlying output stream.
 void write(byte[] buf, int offset, int len)
          This method writes len bytes from the byte array buf starting at position offset in the buffer.
 void write(int b)
          This method writes a single byte of data.
 
Methods inherited from class java.io.FilterOutputStream
close, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buf

protected byte[] buf
This is the internal byte array used for buffering output before writing it.


count

protected int count
This is the number of bytes that are currently in the buffer and are waiting to be written to the underlying stream. It always points to the index into the buffer where the next byte of data will be stored

Constructor Detail

BufferedOutputStream

public BufferedOutputStream(OutputStream out)
This method initializes a new BufferedOutputStream instance that will write to the specified subordinate OutputStream and which will use a default buffer size of 512 bytes.

Parameters:
out - The underlying OutputStream to write data to

BufferedOutputStream

public BufferedOutputStream(OutputStream out,
                            int size)
This method initializes a new BufferedOutputStream instance that will write to the specified subordinate OutputStream and which will use the specified buffer size

Parameters:
out - The underlying OutputStream to write data to
size - The size of the internal buffer
Method Detail

flush

public void flush()
           throws IOException
This method causes any currently buffered bytes to be immediately written to the underlying output stream.

Specified by:
flush in interface Flushable
Overrides:
flush in class FilterOutputStream
Throws:
IOException - If an error occurs

write

public void write(int b)
           throws IOException
This method writes a single byte of data. This will be written to the buffer instead of the underlying data source. However, if the buffer is filled as a result of this write request, it will be flushed to the underlying output stream.

Overrides:
write in class FilterOutputStream
Parameters:
b - The byte of data to be written, passed as an int
Throws:
IOException - If an error occurs

write

public void write(byte[] buf,
                  int offset,
                  int len)
           throws IOException
This method writes len bytes from the byte array buf starting at position offset in the buffer. These bytes will be written to the internal buffer. However, if this write operation fills the buffer, the buffer will be flushed to the underlying output stream.

Overrides:
write in class FilterOutputStream
Parameters:
buf - The array of bytes to write.
offset - The index into the byte array to start writing from.
len - The number of bytes to write.
Throws:
IOException - If an error occurs