jodd.io
Class FastByteArrayOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by jodd.io.FastByteArrayOutputStream
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable

public class FastByteArrayOutputStream
extends java.io.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.


Constructor Summary
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
 void close()
          Closing a FastByteArrayOutputStream has no effect.
 void reset()
           
 int size()
           
 byte[] toByteArray()
           
 java.lang.String toString()
           
 java.lang.String toString(java.lang.String enc)
           
 void write(byte[] b, int off, int len)
           
 void write(int b)
          Calls the write(byte[]) method.
 void writeTo(java.io.OutputStream out)
           
 
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()
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.
Throws:
java.lang.IllegalArgumentException - if size is negative.
Method Detail

write

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

write

public void write(int b)
Calls the write(byte[]) method.

Specified by:
write in class java.io.OutputStream
See Also:
OutputStream.write(int)

size

public int size()
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 java.io.Closeable
Overrides:
close in class java.io.OutputStream

reset

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

writeTo

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

toByteArray

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
ByteArrayOutputStream.toString()

toString

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


Copyright ©2008 Jodd Team