Skip to content

Most visited

Recently visited

navigation
Added in API level 1

ByteArrayOutputStream

public class ByteArrayOutputStream
extends OutputStream

java.lang.Object
   ↳ java.io.OutputStream
     ↳ 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.

Summary

Fields

protected byte[] buf

The buffer where data is stored.

protected int count

The number of valid bytes in the buffer.

Public constructors

ByteArrayOutputStream()

Creates a new byte array output stream.

ByteArrayOutputStream(int size)

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

Public methods

void close()

Closing a ByteArrayOutputStream has no effect.

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.

int size()

Returns the current size of the buffer.

byte[] toByteArray()

Creates a newly allocated byte array.

String toString(String charsetName)

Converts the buffer's contents into a string by decoding the bytes using the specified charsetName.

String toString()

Converts the buffer's contents into a string decoding bytes using the platform's default character set.

String toString(int hibyte)

This method was deprecated in API level 1. 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.

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.

void write(int b)

Writes the specified byte to this byte array output stream.

void writeTo(OutputStream 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 methods

From class java.io.OutputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable
From interface java.lang.AutoCloseable

Fields

buf

Added in API level 1
byte[] buf

The buffer where data is stored.

count

Added in API level 1
int count

The number of valid bytes in the buffer.

Public constructors

ByteArrayOutputStream

Added in API level 1
ByteArrayOutputStream ()

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

ByteArrayOutputStream

Added in API level 1
ByteArrayOutputStream (int size)

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

Parameters
size int: the initial size.
Throws
IllegalArgumentException if size is negative.

Public methods

close

Added in API level 1
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

reset

Added in API level 1
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:

size

Added in API level 1
int size ()

Returns the current size of the buffer.

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

See also:

toByteArray

Added in API level 1
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
byte[] the current contents of this output stream, as a byte array.

See also:

toString

Added in API level 1
String toString (String charsetName)

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

Parameters
charsetName String: the name of a supported charset
Returns
String String decoded from the buffer's contents.
Throws
UnsupportedEncodingException If the named charset is not supported

toString

Added in API level 1
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 CharsetDecoder class should be used when more control over the decoding process is required.

Returns
String String decoded from the buffer's contents.

toString

Added in API level 1
String toString (int hibyte)

This method was deprecated in API level 1.
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))
 

Parameters
hibyte int: the high byte of each resulting Unicode character.
Returns
String the current contents of the output stream, as a string.

See also:

write

Added in API level 1
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 byte: the data.
off int: the start offset in the data.
len int: the number of bytes to write.

write

Added in API level 1
void write (int b)

Writes the specified byte to this byte array output stream.

Parameters
b int: the byte to be written.

writeTo

Added in API level 1
void writeTo (OutputStream 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 OutputStream: the output stream to which to write the data.
Throws
IOException if an I/O error occurs.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.