|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.OutputStream
org.apache.commons.io.output.ByteArrayOutputStream
public class ByteArrayOutputStream
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.
Field Summary | |
---|---|
private List |
buffers
The list of buffers, which grows and never reduces. |
private int |
count
The total count of bytes written. |
private byte[] |
currentBuffer
The current buffer. |
private int |
currentBufferIndex
The index of the current buffer. |
private static byte[] |
EMPTY_BYTE_ARRAY
A singleton empty byte array. |
private int |
filledBufferSum
The total count of bytes in all the filled buffers. |
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()
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. |
void |
write(byte[] b,
int off,
int len)
|
void |
write(int b)
|
void |
writeTo(OutputStream out)
Writes the entire contents of this byte stream to the specified output stream. |
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 |
Field Detail |
---|
private static final byte[] EMPTY_BYTE_ARRAY
private List buffers
private int currentBufferIndex
private int filledBufferSum
private byte[] currentBuffer
private int count
Constructor Detail |
---|
public ByteArrayOutputStream()
public ByteArrayOutputStream(int size)
size
- the initial size
IllegalArgumentException
- if size is negativeMethod Detail |
---|
private byte[] getBuffer(int index)
byte[]
buffer
specified by index.
index
- the index of the buffer required
private void needNewBuffer(int newcount)
newcount
- the size of the buffer if one is createdpublic void write(byte[] b, int off, int len)
write
in class OutputStream
OutputStream.write(byte[], int, int)
public void write(int b)
write
in class OutputStream
OutputStream.write(int)
public int size()
ByteArrayOutputStream.size()
public void close() throws IOException
close
in interface Closeable
close
in class OutputStream
IOException
- never (this method should not declare this exception
but it has to now due to backwards compatability)public void reset()
ByteArrayOutputStream.reset()
public void writeTo(OutputStream out) throws IOException
out
- the output stream to write to
IOException
- if an I/O error occurs, such as if the stream is closedByteArrayOutputStream.writeTo(OutputStream)
public byte[] toByteArray()
ByteArrayOutputStream.toByteArray()
public String toString()
toString
in class Object
ByteArrayOutputStream.toString()
public String toString(String enc) throws UnsupportedEncodingException
enc
- the name of the character encoding
UnsupportedEncodingException
- if the encoding is not supportedByteArrayOutputStream.toString(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |