BufferedOutputStream (Codename One API)

java.lang.Object
- java.io.OutputStream
- - com.codename1.io.BufferedOutputStream

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

TarOutputStream
```
public class BufferedOutputStream
extends OutputStream
```
Based on the buffered output stream from the JDK with some minor tweaks to allow external classes to monitor stream status and progress.

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] buf
The internal buffer where data is stored.

protected int count
The number of valid bytes in the buffer.

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

Constructor Summary

Constructors
Constructor and 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.
`BufferedOutputStream(OutputStream out, int size, String name)` Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size.
`BufferedOutputStream(OutputStream out, String name)` Creates a new buffered output stream to write data to the specified underlying output stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this output stream and releases any system resources associated with the stream.
`void`	`flush()` Flushes this buffered output stream.
`void`	`flushBuffer()` Flush the internal buffer
`Object`	`getConnection()` If applicable this member represents the connection object for the stream
`static int`	`getDefaultBufferSize()` The default size for a stream buffer
`long`	`getLastActivityTime()` Returns the time of the last activity
`String`	`getName()` Indicates the name of the stream for debugging purposes
`int`	`getTotalBytesWritten()` Returns the total amount of bytes written to this stream so far
`void`	`setConnection(Object connection)` If applicable this member represents the connection object for the stream
`static void`	`setDefaultBufferSize(int aDefaultBufferSize)` The default size for a stream buffer
`void`	`setProgressListener(IOProgressListener progressListener)` Sets the callback for IO updates from a buffered 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 buffered output stream.
`void`	`write(int b)` Writes the specified byte to this buffered output stream.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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 Detail
  - 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,
                            String name)
```
    Creates a new buffered output stream to write data to the specified underlying output stream.
    
    Parameters:
    
    out - the underlying output stream.
    
    name - the name of the stream used for debugging/logging purposes
  - 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.
  - BufferedOutputStream
```
public BufferedOutputStream(OutputStream out,
                            int size,
                            String name)
```
    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.
    
    name - the name of the stream used for debugging/logging purposes
    
    Throws:
    
    IllegalArgumentException - if size <= 0.
- Method Detail
  - getName
```
public String getName()
```
    Indicates the name of the stream for debugging purposes
    
    Returns:
    
    the name of the stream
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Flush the internal buffer
    
    Throws:
    
    IOException
  - write
```
public void write(int b)
           throws IOException
```
    Writes the specified byte to this buffered output stream.
    
    Specified by:
    
    write in class OutputStream
    
    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 OutputStream
    
    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.
  - 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.
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getLastActivityTime
```
public long getLastActivityTime()
```
    Returns the time of the last activity
    
    Returns:
    
    time of the last activity on this stream
  - getTotalBytesWritten
```
public int getTotalBytesWritten()
```
    Returns the total amount of bytes written to this stream so far
    
    Returns:
    
    the total amount of bytes written to this stream so far
  - setProgressListener
```
public void setProgressListener(IOProgressListener progressListener)
```
    Sets the callback for IO updates from a buffered stream
    
    Parameters:
    
    progressListener - the progressListener to set
  - getDefaultBufferSize
```
public static int getDefaultBufferSize()
```
    The default size for a stream buffer
    
    Returns:
    
    the defaultBufferSize
  - setDefaultBufferSize
```
public static void setDefaultBufferSize(int aDefaultBufferSize)
```
    The default size for a stream buffer
    
    Parameters:
    
    aDefaultBufferSize - the defaultBufferSize to set
  - write
```
public void write(byte[] b)
           throws IOException
```
    Writes b.length bytes to this output stream.
    The write method of FilterOutputStream calls its write method of three arguments with the arguments b, 0, and b.length.
    Note that this method does not call the one-argument write method of its underlying stream with the single argument b.
    
    Overrides:
    
    write in class OutputStream
    
    Parameters:
    
    b - the data to be written.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - close
```
public void close()
           throws IOException
```
    Closes this output stream and releases any system resources associated with the stream.
    The close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getConnection
```
public Object getConnection()
```
    If applicable this member represents the connection object for the stream
    
    Returns:
    
    the connection
  - setConnection
```
public void setConnection(Object connection)
```
    If applicable this member represents the connection object for the stream
    
    Parameters:
    
    connection - the connection to set

Class BufferedOutputStream

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buf

count

Constructor Detail

BufferedOutputStream

BufferedOutputStream

BufferedOutputStream

BufferedOutputStream

Method Detail

getName

flushBuffer

write

write

flush

getLastActivityTime

getTotalBytesWritten

setProgressListener

getDefaultBufferSize

setDefaultBufferSize

write

close

getConnection

setConnection