Save This Page
Home » openjdk-7 » java » io » [javadoc | source]
java.io
public class: ByteArrayOutputStream [javadoc | source]
java.lang.Object
   java.io.OutputStream
      java.io.ByteArrayOutputStream

All Implemented Interfaces:
    Flushable, Closeable

Direct Known Subclasses:
    ZOutputStream

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.

Field Summary
protected  byte[] buf    The buffer where data is stored. 
protected  int count    The number of valid bytes in the buffer. 
Constructor:
 public ByteArrayOutputStream() 
 public ByteArrayOutputStream(int size) 
Method from java.io.ByteArrayOutputStream Summary:
close,   reset,   size,   toByteArray,   toString,   toString,   toString,   write,   write,   writeTo
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.io.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() 
    Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.
 public synchronized int size() 
    Returns the current size of the buffer.
 public synchronized byte[] toByteArray() 
    Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
 public synchronized String toString() 
    Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String is a function of the character set, and hence may not be equal to the size of the buffer.

    This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The {@linkplain java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required.

 public synchronized String toString(String charsetName) throws UnsupportedEncodingException 
    Converts the buffer's contents into a string by decoding the bytes using the specified charsetName . The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.

    This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The java.nio.charset.CharsetDecoder class should be used when more control over the decoding process is required.

 public synchronized String toString(int hibyte) 
Deprecated! This - method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(String enc) method, which takes an encoding-name argument, or the toString() method, which uses the platform's default character encoding.

    Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that:
        c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))
    
 public synchronized  void write(int b) 
    Writes the specified byte to this byte array output stream.
 public synchronized  void write(byte[] b,
    int off,
    int len) 
    Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
 public synchronized  void writeTo(OutputStream out) throws IOException 
    Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count).