All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.ByteArrayOutputStream 

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

Variable Index

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

Constructor Index

o ByteArrayOutputStream()
Creates a new byte array output stream.
o 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()
Creates a newly allocated string.
o toString(int)
Creates a newly allocated string. Deprecated.
o toString(String)
Converts input data to a string, using the specified character encoding.
o write(byte[], int, int)
Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
o write(int)
Writes the specified byte 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 
Properties Inheritable 
   buf[]=byte
The buffer where data is stored.

o count 
Properties Inheritable 
   count=int
The number of valid bytes in the buffer.

Constructors

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

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

Parameters:
size - the initial size.

Methods

o write 
    method write(b=int)  public    protect
Writes the specified byte to this byte array output stream.

Parameters:
b - the byte to be written.
Overrides:
write in class OutputStream
o write 
    method write(b=byte[], -
                 off=int, -
                 len=int)  public    protect
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 
    method writeTo(out=OutputStream)  public    protect Signals 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.
o reset 
    method reset()  public    protect
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 toByteArray 
    method toByteArray() returns byte[] public    protect
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 size 
    method size() returns int public
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 toString 
    method toString() returns String public
Creates a newly allocated string. Its size is the current size of this 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:

Returns:
the current contents of this output stream, as a string.
Overrides:
toString in class Object
See Also:
size
o toString 
    method toString(enc=String) returns String public     Signals UnsupportedEncodingException
Converts input data to a string, using the specified character encoding.

Parameters:
enc - a character-encoding name.
o toString 
    method toString(hibyte=int) returns String public
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 using the toString method that takes an encoding-name argument, or that 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 bits set.
Returns:
the current contents of the output stream, as a string.
See Also:
size 
All Packages  Class Hierarchy  This Package  Previous  Next  Index