Save This Page
Home » commons-io-current-src » org.apache.commons » io » output » [javadoc | source]
org.apache.commons.io.output
public class: ByteArrayOutputStream [javadoc | source]
java.lang.Object
   java.io.OutputStream
      org.apache.commons.io.output.ByteArrayOutputStream

All Implemented Interfaces:
    Closeable, Flushable

This class implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it.

The data can be retrieved using toByteArray() and toString().

Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

This is an alternative implementation of the java.io.ByteArrayOutputStream class. The original implementation only allocates 32 bytes at the beginning. As this class is designed for heavy duty it starts at 1024 bytes. In contrast to the original it doesn't reallocate the whole memory block but allocates additional buffers. This way no buffers need to be garbage collected and the contents don't have to be copied to the new buffer. This class is designed to behave exactly like the original. The only exception is the deprecated toString(int) method that has been ignored.

Constructor:
 public ByteArrayOutputStream() 
 public ByteArrayOutputStream(int size) 
Method from org.apache.commons.io.output.ByteArrayOutputStream Summary:
close,   reset,   size,   toByteArray,   toString,   toString,   write,   write,   write,   writeTo
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.io.output.ByteArrayOutputStream Detail:
 public  void close() throws IOException 
    Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
 public synchronized  void reset() 
 public synchronized int size() 
    Return the current size of the byte array.
 public synchronized byte[] toByteArray() 
    Gets the curent contents of this byte stream as a byte array. The result is independent of this stream.
 public String toString() 
    Gets the curent contents of this byte stream as a string.
 public String toString(String enc) throws UnsupportedEncodingException 
    Gets the curent contents of this byte stream as a string using the specified encoding.
 public synchronized  void write(int b) 
    Write a byte to byte array.
 public synchronized int write(InputStream in) throws IOException 
    Writes the entire contents of the specified input stream to this byte stream. Bytes from the input stream are read directly into the internal buffers of this streams.
 public  void write(byte[] b,
    int off,
    int len) 
    Write the bytes to byte array.
 public synchronized  void writeTo(OutputStream out) throws IOException 
    Writes the entire contents of this byte stream to the specified output stream.