Class ByteArrayOutputStream
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
public class ByteArrayOutputStream
extends java.io.OutputStream
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.
- Version:
- $Id: ByteArrayOutputStream.java 1021884 2010-10-12 18:49:16Z ggregory $
-
Constructor Summary
Constructors Constructor Description 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
Modifier and Type Method Description void
close()
Closing a ByteArrayOutputStream has no effect.void
reset()
int
size()
Return the current size of the byte array.static java.io.InputStream
toBufferedInputStream(java.io.InputStream input)
Fetches entire contents of anInputStream
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.void
write(int b)
Write a byte to byte array.int
write(java.io.InputStream in)
Writes the entire contents of the specified input stream to this byte stream.void
writeTo(java.io.OutputStream out)
Writes the entire contents of this byte stream to the specified output stream.
-
Constructor Details
-
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.- Parameters:
size
- the initial size- Throws:
java.lang.IllegalArgumentException
- if size is negative
-
-
Method Details
-
write
public void write(byte[] b, int off, int len)Write the bytes to byte array.- Overrides:
write
in classjava.io.OutputStream
- Parameters:
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.- Specified by:
write
in classjava.io.OutputStream
- Parameters:
b
- the byte to write
-
write
public int write(java.io.InputStream in) throws java.io.IOExceptionWrites 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.- Parameters:
in
- the input stream to read from- Returns:
- total number of bytes read from the input stream (and written to this stream)
- Throws:
java.io.IOException
- if an I/O error occurs while reading the input stream- Since:
- Commons IO 1.4
-
size
public int size()Return the current size of the byte array.- Returns:
- the current size of the byte array
-
close
public void close() throws java.io.IOExceptionClosing a ByteArrayOutputStream 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 interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.OutputStream
- Throws:
java.io.IOException
- never (this method should not declare this exception but it has to now due to backwards compatability)
-
reset
public void reset()- See Also:
ByteArrayOutputStream.reset()
-
writeTo
public void writeTo(java.io.OutputStream out) throws java.io.IOExceptionWrites the entire contents of this byte stream to the specified output stream.- Parameters:
out
- the output stream to write to- Throws:
java.io.IOException
- if an I/O error occurs, such as if the stream is closed- See Also:
ByteArrayOutputStream.writeTo(OutputStream)
-
toBufferedInputStream
public static java.io.InputStream toBufferedInputStream(java.io.InputStream input) throws java.io.IOExceptionFetches entire contents of anInputStream
and represent same data as result InputStream.This method is useful where,
- Source InputStream is slow.
- It has network resources associated, so we cannot keep it open for long time.
- It has network timeout associated.
toByteArray()
, since it avoids unnecessary allocation and copy of byte[].
This method buffers the input internally, so there is no need to use aBufferedInputStream
.- Parameters:
input
- Stream to be fully buffered.- Returns:
- A fully buffered stream.
- Throws:
java.io.IOException
- if an I/O error occurs- Since:
- Commons IO 2.0
-
toByteArray
public byte[] toByteArray()Gets the curent contents of this byte stream as a byte array. The result is independent of this stream.- Returns:
- the current contents of this output stream, as a byte array
- See Also:
ByteArrayOutputStream.toByteArray()
-
toString
public java.lang.String toString()Gets the curent contents of this byte stream as a string.- Overrides:
toString
in classjava.lang.Object
- Returns:
- the contents of the byte array as a String
- See Also:
ByteArrayOutputStream.toString()
-
toString
public java.lang.String toString(java.lang.String enc) throws java.io.UnsupportedEncodingExceptionGets the curent contents of this byte stream as a string using the specified encoding.- Parameters:
enc
- the name of the character encoding- Returns:
- the string converted from the byte array
- Throws:
java.io.UnsupportedEncodingException
- if the encoding is not supported- See Also:
ByteArrayOutputStream.toString(String)
-