FileDocCategorySizeDatePackage
ByteArrayOutputStream.javaAPI DocJava SE 5 API7018Fri Aug 26 14:56:58 BST 2005java.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().

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

author
Arthur van Hoff
version
1.49, 05/18/04
since
JDK1.0

Fields Summary
protected byte[]
buf
The buffer where data is stored.
protected int
count
The number of valid bytes in the buffer.
Constructors Summary
public ByteArrayOutputStream()
Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

	this(32);
    
public ByteArrayOutputStream(int size)
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

param
size the initial size.
exception
IllegalArgumentException if size is negative.

        if (size < 0) {
            throw new IllegalArgumentException("Negative initial size: "
                                               + size);
        }
	buf = new byte[size];
    
Methods Summary
public voidclose()
Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

    
public synchronized voidreset()
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
java.io.ByteArrayInputStream#count

	count = 0;
    
public intsize()
Returns the current size of the buffer.

return
the value of the count field, which is the number of valid bytes in this output stream.
see
java.io.ByteArrayOutputStream#count

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

return
the current contents of this output stream, as a byte array.
see
java.io.ByteArrayOutputStream#size()

	byte newbuf[] = new byte[count];
	System.arraycopy(buf, 0, newbuf, 0, count);
	return newbuf;
    
public java.lang.StringtoString(java.lang.String enc)
Converts the buffer's contents into a string, translating bytes into characters according to the specified character encoding.

param
enc a character-encoding name.
return
String translated from the buffer's contents.
throws
UnsupportedEncodingException If the named encoding is not supported.
since
JDK1.1

	return new String(buf, 0, count, enc);
    
public java.lang.StringtoString(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.
param
hibyte the high byte of each resulting Unicode character.
return
the current contents of the output stream, as a string.
see
java.io.ByteArrayOutputStream#size()
see
java.io.ByteArrayOutputStream#toString(String)
see
java.io.ByteArrayOutputStream#toString()

	return new String(buf, hibyte, 0, count);
    
public java.lang.StringtoString()
Converts the buffer's contents into a string, translating bytes into characters according to the platform's default character encoding.

return
String translated from the buffer's contents.
since
JDK1.1

	return new String(buf, 0, count);
    
public synchronized voidwrite(int b)
Writes the specified byte to this byte array output stream.

param
b the byte to be written.

	int newcount = count + 1;
	if (newcount > buf.length) {
	    byte newbuf[] = new byte[Math.max(buf.length << 1, newcount)];
	    System.arraycopy(buf, 0, newbuf, 0, count);
	    buf = newbuf;
	}
	buf[count] = (byte)b;
	count = newcount;
    
public synchronized voidwrite(byte[] b, int off, int len)
Writes len bytes from the specified byte array starting at offset off to this byte array output stream.

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

	if ((off < 0) || (off > b.length) || (len < 0) ||
            ((off + len) > b.length) || ((off + len) < 0)) {
	    throw new IndexOutOfBoundsException();
	} else if (len == 0) {
	    return;
	}
        int newcount = count + len;
        if (newcount > buf.length) {
            byte newbuf[] = new byte[Math.max(buf.length << 1, newcount)];
            System.arraycopy(buf, 0, newbuf, 0, count);
            buf = newbuf;
        }
        System.arraycopy(b, off, buf, count, len);
        count = newcount;
    
public synchronized voidwriteTo(java.io.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).

param
out the output stream to which to write the data.
exception
IOException if an I/O error occurs.

	out.write(buf, 0, count);