com.varra.io

Class FastByteArrayOutputStream

java.lang.Object

java.io.OutputStream

com.varra.io.FastByteArrayOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FastByteArrayOutputStream
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 FastByteArrayOutputStream 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.FastByteArrayOutputStream 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 depreciated toString(int) method that has been ignored.

Version:

1.0

Author:

Rajakrishna V. Reddy

Constructor Summary

Constructors

Constructor and Description
FastByteArrayOutputStream() Creates a new byte array output stream.
FastByteArrayOutputStream(int size) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary

Modifier and Type	Method and Description
void	close() Closing a FastByteArrayOutputStream has no effect.
void	reset() Reset.
int	size() Size.
byte[]	toByteArray() To byte array.
String	toString() To string.
String	toString(String enc) To string.
void	write(byte[] b, int off, int len) Write.
void	write(int b) Writes single byte.
void	writeTo(OutputStream out) Write to.

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FastByteArrayOutputStream

public FastByteArrayOutputStream()

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

FastByteArrayOutputStream

public FastByteArrayOutputStream(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 Detail

write

public void write(byte[] b,
                  int off,
                  int len)

Write.

Overrides:

write in class OutputStream

Parameters:

b - the b

off - the off

len - the len

See Also:

OutputStream.write(byte[], int, int)

write

public void write(int b)

Writes single byte.

Specified by:

write in class OutputStream

Parameters:

b - the b

size

public int size()

Size.

Returns:

the int

See Also:

ByteArrayOutputStream.size()

close

public void close()

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

reset

public void reset()

Reset.

See Also:

ByteArrayOutputStream.reset()

writeTo

public void writeTo(OutputStream out)
             throws IOException

Write to.

Parameters:

out - the out

Throws:

IOException - Signals that an I/O exception has occurred.

See Also:

ByteArrayOutputStream.writeTo(OutputStream)

toByteArray

public byte[] toByteArray()

To byte array.

Returns:

the byte[]

See Also:

ByteArrayOutputStream.toByteArray()

toString

public String toString()

To string.

Overrides:

toString in class Object

Returns:

the string

See Also:

ByteArrayOutputStream.toString()

toString

public String toString(String enc)
                throws UnsupportedEncodingException

To string.

Parameters:

enc - the enc

Returns:

the string

Throws:

UnsupportedEncodingException - the unsupported encoding exception

See Also:

ByteArrayOutputStream.toString(String)