java.io
class ByteArrayOutputStream

java.lang.Object java.io.OutputStream java.io.ByteArrayOutputStream

All Implemented Interfaces:

Closeable, Flushable

Most common way to construct:

ByteArrayOutputStream baos = new ByteArrayOutputStream();

Based on 629 examples

public class ByteArrayOutputStream
extends OutputStream

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.

See Also (auto-generated):

InputStream

File

ByteArrayInputStream

buf

protected byte[] buf

The buffer where data is stored.

count

protected int count

The number of valid bytes in the buffer.

ByteArrayOutputStream

public ByteArrayOutputStream()

Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

ByteArrayOutputStream

public ByteArrayOutputStream(int size)

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Parameters:

size - the initial size.

close

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.

Overrides:

close in class OutputStream

Throws:

IOException

reset

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.

size

public synchronized int size()

Returns the current size of the buffer.

Returns:

the value of the count field, which is the number of valid bytes in this output stream.

toByteArray

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.

Returns:

the current contents of this output stream, as a byte array.

toString

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.

Overrides:

toString in class Object

Returns:

String decoded from the buffer's contents.

toString

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:

hibyte - the high byte of each resulting Unicode character.

Returns:

the current contents of the output stream, as a string.

toString

public synchronized String toString(String charsetName)
                             throws UnsupportedEncodingException

Converts the buffer's contents into a string by decoding the bytes using the specified {@link java.nio.charset.Charset 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 {@link java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required.

Parameters:

charsetName - the name of a supported {@linkplain java.nio.charset.Charset charset}

Returns:

String decoded from the buffer's contents.

Throws:

UnsupportedEncodingException - If the named charset is not supported

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

public synchronized void write(int b)

public synchronized void writeTo(OutputStream out)
                          throws IOException