BufferedOutputStream

public class BufferedOutputStream
extends FilterOutputStream

java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
       ↳ java.io.BufferedOutputStream


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.

Summary

Fields

protected byte[] buf

The internal buffer where data is stored.

protected int count

The number of valid bytes in the buffer.

Inherited fields

protected OutputStream out

The underlying output stream to be filtered.

Public constructors

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.

Public methods

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.

Inherited methods

void close()

Closes this output stream and releases any system resources associated with the stream.

void flush()

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

void write(byte[] b)

Writes b.length bytes to this output stream.

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

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

void write(int b)

Writes the specified byte to this output stream.

void close()

Closes this output stream and releases any system resources associated with this stream.

void flush()

Flushes this output stream and forces any buffered output bytes to be written out.

static OutputStream nullOutputStream()

Returns a new OutputStream which discards all bytes.

void write(byte[] b)

Writes b.length bytes from the specified byte array to this output stream.

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

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

abstract void write(int b)

Writes the specified byte to this output stream.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract void close()

Closes this stream and releases any system resources associated with it.

abstract void flush()

Flushes this stream by writing any buffered output to the underlying stream.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Fields

buf

Added in API level 1
protected byte[] buf

The internal buffer where data is stored.

count

Added in API level 1
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.

Public constructors

BufferedOutputStream

Added in API level 1
public BufferedOutputStream (OutputStream out)

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

Parameters
out OutputStream: the underlying output stream.

BufferedOutputStream

Added in API level 1
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 OutputStream: the underlying output stream.

size int: the buffer size.

Throws
IllegalArgumentException if size <= 0.

Public methods

flush

Added in API level 1
public void flush ()

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

Throws
IOException if an I/O error occurs.

write

Added in API level 1
public 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.

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.

Parameters
b byte: the data.

off int: the start offset in the data.

len int: the number of bytes to write.

Throws
IOException if an I/O error occurs.

write

Added in API level 1
public void write (int b)

Writes the specified byte to this buffered output stream.

Parameters
b int: the byte to be written.

Throws
IOException if an I/O error occurs.