|
|||||||||
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 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 java.util.List<byte[]> |
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 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. |
private java.io.InputStream |
toBufferedInputStream()
Gets the current contents of this byte stream as a Input Stream. |
static java.io.InputStream |
toBufferedInputStream(java.io.InputStream input)
Fetches entire contents of an InputStream and represent
same data as result InputStream. |
byte[] |
toByteArray()
Gets the curent contents of this byte stream as a byte array. |
java.lang.String |
toString()
Gets the curent contents of this byte stream as a string. |
java.lang.String |
toString(java.lang.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)
Write the bytes to byte array. |
int |
write(java.io.InputStream in)
Writes the entire contents of the specified input stream to this byte stream. |
void |
write(int b)
Write a byte to byte array. |
void |
writeTo(java.io.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 final java.util.List<byte[]> 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
java.lang.IllegalArgumentException
- if size is negativeMethod Detail |
---|
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 java.io.OutputStream
b
- the bytes to writeoff
- The start offsetlen
- The number of bytes to writepublic void write(int b)
write
in class java.io.OutputStream
b
- the byte to writepublic int write(java.io.InputStream in) throws java.io.IOException
in
- the input stream to read from
java.io.IOException
- if an I/O error occurs while reading the input streampublic int size()
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in class java.io.OutputStream
java.io.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(java.io.OutputStream out) throws java.io.IOException
out
- the output stream to write to
java.io.IOException
- if an I/O error occurs, such as if the stream is closedByteArrayOutputStream.writeTo(OutputStream)
public static java.io.InputStream toBufferedInputStream(java.io.InputStream input) throws java.io.IOException
InputStream
and represent
same data as result InputStream.
This method is useful where,
toByteArray()
, since it
avoids unnecessary allocation and copy of byte[].BufferedInputStream
.
input
- Stream to be fully buffered.
java.io.IOException
- if an I/O error occursprivate java.io.InputStream toBufferedInputStream()
this
stream,
avoiding memory allocation and copy, thus saving space and time.
ByteArrayOutputStream.toByteArray()
,
reset()
public byte[] toByteArray()
ByteArrayOutputStream.toByteArray()
public java.lang.String toString()
toString
in class java.lang.Object
ByteArrayOutputStream.toString()
public java.lang.String toString(java.lang.String enc) throws java.io.UnsupportedEncodingException
enc
- the name of the character encoding
java.io.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 |