org.gridfour.io

Class FastByteArrayOutputStream

java.lang.Object

java.io.OutputStream

org.gridfour.io.FastByteArrayOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FastByteArrayOutputStream
extends OutputStream

Provides a faster equivalent of Java's ByteArrayOutputStream. The stock Java class implements a thread-safe behavior by including synchronization in its method calls. While convenient for some applications, that approach reduces throughput. Therefore this class is implemented without synchronization.

Caution: This class is not thread safe.

Constructor Summary

Constructors

Constructor and Description
FastByteArrayOutputStream() Standard constructor.
FastByteArrayOutputStream(int initialAllocation) Constructs an instance of this class with the specified initial buffer size.

Method Summary

Modifier and Type	Method and Description
void	close()
int	getSize() Gets the size of the data collection, in bytes.
byte[]	toByteArray() Gets the content of the buffer in the form of a byte array.
String	toString()
void	write(byte[] data, int poffset, int plength)
void	write(int datum)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FastByteArrayOutputStream

public FastByteArrayOutputStream()

Standard constructor.

FastByteArrayOutputStream

public FastByteArrayOutputStream(int initialAllocation)

Constructs an instance of this class with the specified initial buffer size.

Parameters:

initialAllocation - the initial buffer size, in bytes.

Method Detail

getSize

public int getSize()

Gets the size of the data collection, in bytes.

Returns:

a value of zero or greater.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

toByteArray

public byte[] toByteArray()

Gets the content of the buffer in the form of a byte array. This routine always constructs a new instance of the content.

Returns:

A new byte array containing the content of the buffer.

toString

public String toString()

Overrides:

toString in class Object

write

public void write(int datum)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] data,
                  int poffset,
                  int plength)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException