Class java.io.ByteArrayOutputStream 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.ByteArrayOutputStream 

Object
   |
   +----OutputStream
           |
           +----java.io.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().

Version:
1.24, 07/01/98
Author:
Arthur van Hoff
Since:
JDK1.0

Variable Index

o buf
The buffer where data is stored.
o count
The number of valid bytes in the buffer.

Constructor Index

o java.io.ByteArrayOutputStream()
Creates a new byte array output stream.
o java.io.ByteArrayOutputStream(int)
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Index

o reset()
Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the ouput stream is discarded.
o size()
Returns the current size of the buffer.
o toByteArray()
Creates a newly allocated byte array.
o toString()
Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.
o toString(String)
Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.
o toString(int)
Creates a newly allocated string.
o write(int)
Writes the specified byte to this byte array output stream.
o write(byte[], int, int)
Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
o writeTo(OutputStream)
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).

Variables

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

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

Constructors

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

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

Methods

o 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 ouput stream is discarded. The output stream can be used again, reusing the already allocated buffer space.

See Also:
count
o size 
public 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:
count
o 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.
See Also:
size()
o toString 
public java.lang.String toString()
Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.

Overrides:
toString in class Object
o toString 
public java.lang.String toString(String enc) throws UnsupportedEncodingException
Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.

Parameters:
enc - a character-encoding name.
Since:
JDK1.1
o toString 
public java.lang.String toString(int hibyte)
Note: toString() 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:

Parameters:
hibyte - the high byte of each resulting Unicode character.
Returns:
the current contents of the output stream, as a string.
See Also:
size(), toString(String), toString()
o write 
public synchronized void write(int b)
Writes the specified byte to this byte array output stream.

Parameters:
b - the byte to be written.
Overrides:
write in class OutputStream
o 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.

Parameters:
b - the data.
off - the start offset in the data.
len - the number of bytes to write.
Overrides:
write in class OutputStream
o writeTo 
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:
out - the output stream to which to write the data.
Throws: IOException
if an I/O error occurs. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index