File	Doc	Category	Size	Date	Package
ByteArrayOutputStream.java	API Doc	Java SE 6 API	7875	Tue Jun 10 00:25:32 BST 2008	java.io

ByteArrayOutputStream

• java.lang.Object
  • java.io.OutputStream

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 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.
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. see java.io.ByteArrayInputStream#count count = 0;
public synchronized int	size() 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() return Arrays.copyOf(buf, count);
public synchronized java.lang.String	toString(java.lang.String charsetName) Converts the buffer's contents into a string by decoding the bytes using the specified {@link java.nio.charset.Charset 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 {@link java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required. param charsetName the name of a supported {@linkplain java.nio.charset.Charset charset} return String decoded from the buffer's contents. exception UnsupportedEncodingException If the named charset is not supported since JDK1.1 return new String(buf, 0, count, charsetName);
public synchronized java.lang.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. 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 synchronized java.lang.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 {@linkplain java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required. return String decoded from the buffer's contents. since JDK1.1 return new String(buf, 0, count);
public synchronized void	write(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) { buf = Arrays.copyOf(buf, Math.max(buf.length << 1, newcount)); } buf[count] = (byte)b; count = newcount;
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. 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) { buf = Arrays.copyOf(buf, Math.max(buf.length << 1, newcount)); } System.arraycopy(b, off, buf, count, len); count = newcount;
public synchronized void	writeTo(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);