org.apache.commons.io.output
Class ByteArrayOutputStream
OutputStream
org.apache.commons.io.output.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.
$Id: ByteArrayOutputStream.java 610010 2008-01-08 14:50:59Z niallp $
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() - Return the current size of the byte array.
|
byte[] | toByteArray() - Gets the curent contents of this byte stream as a byte array.
|
String | toString() - Gets the curent contents of this byte stream as a string.
|
String | toString(String enc) - Gets the curent contents of this byte stream as a string
using the specified encoding.
|
int | write(InputStream in) - Writes the entire contents of the specified input stream to this
byte stream.
|
void | write(byte[] b, int off, int len) - Write the bytes to byte array.
|
void | write(int b) - Write a byte to byte array.
|
void | writeTo(OutputStream out) - Writes the entire contents of this byte stream to the
specified output stream.
|
EMPTY_BYTE_ARRAY
private static final byte[] EMPTY_BYTE_ARRAY
A singleton empty byte array.
buffers
private List buffers
The list of buffers, which grows and never reduces.
count
private int count
The total count of bytes written.
currentBuffer
private byte[] currentBuffer
The current buffer.
currentBufferIndex
private int currentBufferIndex
The index of the current buffer.
filledBufferSum
private int filledBufferSum
The total count of bytes in all the filled buffers.
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.
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.
index
- the index of the buffer required
needNewBuffer
private void needNewBuffer(int newcount)
Makes a new buffer available either by allocating
a new one or re-cycling an existing one.
newcount
- the size of the buffer if one is created
reset
public void reset()
java.io.ByteArrayOutputStream.reset()
size
public int size()
Return the current size of the byte array.
- the current size of the byte array
toByteArray
public byte[] toByteArray()
Gets the curent contents of this byte stream as a byte array.
The result is independent of this stream.
- the current contents of this output stream, as a byte array
java.io.ByteArrayOutputStream.toByteArray()
toString
public String toString()
Gets the curent contents of this byte stream as a string.
- the contents of the byte array as a String
java.io.ByteArrayOutputStream.toString()
toString
public String toString(String enc)
throws UnsupportedEncodingException
Gets the curent contents of this byte stream as a string
using the specified encoding.
enc
- the name of the character encoding
- the string converted from the byte array
java.io.ByteArrayOutputStream.toString(String)
write
public int write(InputStream in)
throws IOException
Writes the entire contents of the specified input stream to this
byte stream. Bytes from the input stream are read directly into the
internal buffers of this streams.
in
- the input stream to read from
- total number of bytes read from the input stream
(and written to this stream)
write
public void write(byte[] b,
int off,
int len)
Write the bytes to byte array.
b
- the bytes to writeoff
- The start offsetlen
- The number of bytes to write
write
public void write(int b)
Write a byte to byte array.
writeTo
public void writeTo(OutputStream out)
throws IOException
Writes the entire contents of this byte stream to the
specified output stream.
out
- the output stream to write to
java.io.ByteArrayOutputStream.writeTo(OutputStream)
Copyright (c) 2002-2008 Apache Software Foundation