java.io
Class ByteArrayOutputStream

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.

SinceJDK1.0
Version1.59, 05/05/07
AuthorArthur van Hoff
Wiki javadoc Use textile entry format.

asdfsdaf

Field Summary
protected byte[] buf
The buffer where data is stored.
protected int count
The number of valid bytes in the buffer.
Constructor Summary
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.
Method Summary
void close()
Closing a ByteArrayOutputStream has no effect.
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.
synchronized int size()
Returns the current size of the buffer.
synchronized byte[] toByteArray()
Creates a newly allocated byte array.
synchronized String toString()
Converts the buffer's contents into a string decoding bytes using the platform's default character set.
synchronized String toString( String charsetName )
Converts the buffer's contents into a string by decoding the bytes using the specified charsetName .
synchronized String toString( int hibyte )
Creates a newly allocated string.
synchronized void write( int b )
Writes the specified byte to this byte array output stream.
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.
synchronized 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).
Methods inherited from java.ioFlushable
Methods inherited from java.ioOutputStream
buf
protected byte[] buf
The buffer where data is stored.
Wiki javadoc Use textile entry format.
Add your comments here.
count
protected int count
The number of valid bytes in the buffer.
Wiki javadoc Use textile entry format.
Add your comments here.
ByteArrayOutputStream
public ByteArrayOutputStream ( )
Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.
Wiki javadoc Use textile entry format.
Add your comments here.
ByteArrayOutputStream
public ByteArrayOutputStream ( int size )
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
Parameters
TypeNameDescription
int size the initial size.
Wiki javadoc Use textile entry format.
Add your comments here.
close
public void close ( )
throws
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 method in OutputStream
Returns void No description provided.
Exceptions
IOException No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
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.
Returns void No description provided.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
size
public synchronized int size ( )
Returns the current size of the buffer.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
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.
See also
Wiki javadoc Use textile entry format.
Add your comments here.
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 CharsetDecoder class should be used when more control over the decoding process is required.

Since: JDK1.1
Overrides method in Object
Wiki javadoc Use textile entry format.
Add your comments here.
toString
public synchronized 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.

Since: JDK1.1
Parameters
TypeNameDescription
String charsetName the name of a supported charset
Exceptions
UnsupportedEncodingException If the named charset is not supported
Wiki javadoc Use textile entry format.
Add your comments here.
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))
 
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.
Parameters
TypeNameDescription
int hibyte the high byte of each resulting Unicode character.
Wiki javadoc Use textile entry format.
Add your comments here.
write
public synchronized void write ( int b )
Writes the specified byte to this byte array output stream.
Overrides method in OutputStream
Parameters
TypeNameDescription
int b the byte to be written.
Returns void No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
write
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.
Overrides method in OutputStream
Parameters
TypeNameDescription
byte[] b the data.
int off the start offset in the data.
int len the number of bytes to write.
Returns void No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
writeTo
public synchronized void writeTo ( OutputStream out )
throws
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
TypeNameDescription
OutputStream out the output stream to which to write the data.
Returns void No description provided.
Exceptions
IOException if an I/O error occurs.
Wiki javadoc Use textile entry format.
Add your comments here.