Class: java.io.ByteArrayOutputStream

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.

Authors:
@author Arthur van Hoff
Since:
@since JDK1.0

Inheritance

Superclass tree: Implements:

Methods

  • ByteArrayOutputStreamtop

    public ByteArrayOutputStream()
    Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.
    Google Code Search
    Stack Overflow
  • ByteArrayOutputStreamtop

    public ByteArrayOutputStream(int size)
    Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
    Parameters:
    @param size the initial size.
    Exceptions:
    @exception IllegalArgumentException if size is negative.
    Google Code Search
    Stack Overflow
  • closetop

    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.

    Exceptions:
    @throws IOException if an I/O error occurs
    Specified by:
    close from Closeable
    Override hierarchy:
    close from OutputStream
    Google Code Search
    Stack Overflow
  • resettop

    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.
    See:
    @see java.io.ByteArrayInputStream.count
    Google Code Search
    Stack Overflow
  • sizetop

    public synchronized int size()
    Returns the current size of the buffer.
    Return:
    @return the value of the count field, which is the number of valid bytes in this output stream.
    See:
    @see java.io.ByteArrayOutputStream.count
    Google Code Search
    Stack Overflow
  • toByteArraytop

    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.
    Return:
    @return the current contents of this output stream, as a byte array.
    See:
    @see java.io.ByteArrayOutputStream.size()
    Google Code Search
    Stack Overflow
  • toStringtop

    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 java.nio.charset.CharsetDecoder class should be used when more control over the decoding process is required.

    Return:
    @return String decoded from the buffer's contents.
    Since:
    @since JDK1.1
    Override hierarchy:
    toString from Object
    Google Code Search
    Stack Overflow
  • toStringtop

    public synchronized String toString(int hibyte)
    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))
     
    Parameters:
    @param hibyte the high byte of each resulting Unicode character.
    Return:
    @return the current contents of the output stream, as a string.
    Deprecated:
    @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.
    See:
    @see java.io.ByteArrayOutputStream.size()
    @see java.io.ByteArrayOutputStream.toString(java.lang.String)
    @see java.io.ByteArrayOutputStream.toString()
    Google Code Search
    Stack Overflow
  • toStringtop

    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.

    Parameters:
    @param charsetName the name of a supported charset
    Return:
    @return String decoded from the buffer's contents.
    Exceptions:
    @exception UnsupportedEncodingException If the named charset is not supported
    Since:
    @since JDK1.1
    Google Code Search
    Stack Overflow
  • writetop

    public synchronized void write(int b)
    Writes the specified byte to this byte array output stream.
    Parameters:
    @param b the byte to be written.
    Override hierarchy:
    write from OutputStream
    Google Code Search
    Stack Overflow
  • writetop

    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.
    Parameters:
    @param b the data.
    @param off the start offset in the data.
    @param len the number of bytes to write.
    Override hierarchy:
    write from OutputStream
    Google Code Search
    Stack Overflow
  • writeTotop

    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).
    Parameters:
    @param out the output stream to which to write the data.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Google Code Search
    Stack Overflow

Fields

  • buf

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

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