# ByteArrayOutputStream

public class **ByteArrayOutputStream** extends [OutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html)  
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](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#buf) | The buffer where data is stored. |
| protected int | [count](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#count) | The number of valid bytes in the buffer. |

### Public Constructor Summary

|---|---|
|   | [ByteArrayOutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#ByteArrayOutputStream())() Creates a new byte array output stream. |
|   | [ByteArrayOutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#ByteArrayOutputStream(int))(int size) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes. |

### Public Method Summary

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#close())() Closing a ByteArrayOutputStream has no effect. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#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. |
| synchronized int | [size](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#size())() Returns the current size of the buffer. |
| synchronized byte\[\] | [toByteArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toByteArray())() Creates a newly allocated byte array. |
| synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toString(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) charsetName) Converts the buffer's contents into a string by decoding the bytes using the named `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html`. |
| synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toString())() Converts the buffer's contents into a string decoding bytes using the platform's default character set. |
| synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toString(int))(int hibyte) *This method is 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.* |
| synchronized void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#write(byte[],%20int,%20int))(byte\[\] b, int off, int len) Writes `len` bytes from the specified byte array starting at offset `off` to this byte array output stream. |
| synchronized void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#write(int))(int b) Writes the specified byte to this byte array output stream. |
| synchronized void | [writeTo](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#writeTo(java.io.OutputStream))([OutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html) out) 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)`. |

### Inherited Method Summary

From class [java.io.OutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html)

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html#close())() Closes this output stream and releases any system resources associated with this stream. |
| void | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html#flush())() Flushes this output stream and forces any buffered output bytes to be written out. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html#write(byte[]))(byte\[\] b) Writes `b.length` bytes from the specified byte array to this output stream. |
| void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html#write(byte[],%20int,%20int))(byte\[\] b, int off, int len) Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. |
| abstract void | [write](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html#write(int))(int b) Writes the specified byte to this output stream. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.io.Flushable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Flushable.html)

|---|---|
| abstract void | [flush](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Flushable.html#flush())() Flushes this stream by writing any buffered output to the underlying stream. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Fields

#### protected byte\[\]
**buf**

The buffer where data is stored.

#### protected int
**count**

The number of valid bytes in the buffer.

## Public Constructors

#### public
**ByteArrayOutputStream**
()

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

#### 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. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if size is negative. |
|---|---|

## Public Methods

#### public void
**close**
()

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

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) |   |
|---|---|

#### 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 Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayInputStream.html#count`

#### 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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#count`

#### 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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#size()`

#### public synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) charsetName)

Converts the buffer's contents into a string by decoding the bytes using
the named `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html`. 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/CharsetDecoder.html` class should be used when more control
over the decoding process is required.

##### Parameters

| charsetName | the name of a supported `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/charset/Charset.html` |
|---|---|

##### Returns

- String decoded from the buffer's contents.

##### Throws

| [UnsupportedEncodingException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/UnsupportedEncodingException.html) | If the named charset is not supported |
|---|---|

#### public synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**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.

##### Returns

- String decoded from the buffer's contents.

#### public synchronized [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
(int hibyte)


**This method is 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))
>  
> ```

<br />

##### Parameters

| hibyte | the high byte of each resulting Unicode character. |
|---|---|

##### Returns

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

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#size()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toString(java.lang.String)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/ByteArrayOutputStream.html#toString()`

#### 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

| b | the data. |
| off | the start offset in the data. |
| len | the number of bytes to write. |
|---|---|

#### public synchronized void
**write**
(int b)

Writes the specified byte to this byte array output stream.

##### Parameters

| b | the byte to be written. |
|---|---|

#### public synchronized void
**writeTo**
([OutputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/OutputStream.html) out)

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

| out | the output stream to which to write the data. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs. |
|---|---|