org.apache.commons.io.output

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.

This is an alternative implementation of the java.io.ByteArrayOutputStream class. The original implementation only allocates 32 bytes at the beginning. As this class is designed for heavy duty it starts at 1024 bytes. In contrast to the original it doesn't reallocate the whole memory block but allocates additional buffers. This way no buffers need to be garbage collected and the contents don't have to be copied to the new buffer. This class is designed to behave exactly like the original. The only exception is the deprecated toString(int) method that has been ignored.

Version:
$Id: ByteArrayOutputStream.java 369075 2006-01-14 18:23:42Z scolebourne $
Author:
Jeremias Maerki

Field Summary

private List
buffers
private int
count
private byte[]
currentBuffer
private int
currentBufferIndex
private int
filledBufferSum

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.
private byte[]
getBuffer(int index)
Return the appropriate byte[] buffer specified by index.
private void
needNewBuffer(int newcount)
Makes a new buffer available either by allocating a new one or re-cycling an existing one.
void
reset()
int
size()
byte[]
toByteArray()
String
toString()
String
toString(String enc)
void
write(byte[] b, int off, int len)
void
write(int b)
Calls the write(byte[]) method.
void
writeTo(OutputStream out)

Field Details

buffers

private List buffers

count

private int count

currentBuffer

private byte[] currentBuffer

currentBufferIndex

private int currentBufferIndex

filledBufferSum

private int filledBufferSum

Constructor Details

ByteArrayOutputStream

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

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

Method Details

close

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

getBuffer

private byte[] getBuffer(int index)
Return the appropriate byte[] buffer specified by index.
Parameters:
index - the index of the buffer required
Returns:
the buffer

needNewBuffer

private void needNewBuffer(int newcount)
Makes a new buffer available either by allocating a new one or re-cycling an existing one.
Parameters:
newcount - the size of the buffer if one is created

reset

public void reset()
See Also:
java.io.ByteArrayOutputStream.reset()

size

public int size()
See Also:
java.io.ByteArrayOutputStream.size()

toByteArray

public byte[] toByteArray()
See Also:
java.io.ByteArrayOutputStream.toByteArray()

toString

public String toString()
See Also:
java.io.ByteArrayOutputStream.toString()

toString

public String toString(String enc)
            throws UnsupportedEncodingException
See Also:
java.io.ByteArrayOutputStream.toString(String)

write

public void write(byte[] b,
                  int off,
                  int len)
See Also:
java.io.OutputStream.write(byte[], int, int)

write

public void write(int b)
Calls the write(byte[]) method.
See Also:
java.io.OutputStream.write(int)

writeTo

public void writeTo(OutputStream out)
            throws IOException
See Also:
java.io.ByteArrayOutputStream.writeTo(OutputStream)