Package org.apache.commons.io.output
Class ByteArrayOutputStream
java.lang.Object
java.io.OutputStream
org.apache.commons.io.output.AbstractByteArrayOutputStream
org.apache.commons.io.output.ByteArrayOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
Implements a ThreadSafe version of
AbstractByteArrayOutputStream
using instance synchronization.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.io.output.AbstractByteArrayOutputStream
AbstractByteArrayOutputStream.InputStreamConstructor<T extends InputStream>
-
Field Summary
Fields inherited from class org.apache.commons.io.output.AbstractByteArrayOutputStream
count, DEFAULT_SIZE
-
Constructor Summary
ConstructorsConstructorDescriptionCreates 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 TypeMethodDescriptionvoid
reset()
int
size()
Returns the current size of the byte array.static InputStream
toBufferedInputStream
(InputStream input) Fetches entire contents of anInputStream
and represent same data as result InputStream.static InputStream
toBufferedInputStream
(InputStream input, int size) Fetches entire contents of anInputStream
and represent same data as result InputStream.byte[]
Gets the current contents of this byte stream as a byte array.Gets the current contents of this byte stream as a Input Stream.void
write
(byte[] b, int off, int len) Writes the bytes to the byte array.void
write
(int b) Write a byte to byte array.int
write
(InputStream in) Writes the entire contents of the specified input stream to this byte stream.void
writeTo
(OutputStream out) Writes the entire contents of this byte stream to the specified output stream.Methods inherited from class org.apache.commons.io.output.AbstractByteArrayOutputStream
close, needNewBuffer, resetImpl, toByteArrayImpl, toInputStream, toString, toString, toString, writeImpl, writeImpl, writeImpl, writeToImpl
Methods inherited from class java.io.OutputStream
flush, nullOutputStream, write
-
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:
IllegalArgumentException
- if size is negative
-
-
Method Details
-
write
public void write(byte[] b, int off, int len) Description copied from class:AbstractByteArrayOutputStream
Writes the bytes to the byte array.- Specified by:
write
in classAbstractByteArrayOutputStream
- Parameters:
b
- the bytes to writeoff
- The start offsetlen
- The number of bytes to write
-
write
public void write(int b) Description copied from class:AbstractByteArrayOutputStream
Write a byte to byte array.- Specified by:
write
in classAbstractByteArrayOutputStream
- Parameters:
b
- the byte to write
-
write
Description copied from class:AbstractByteArrayOutputStream
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.- Specified by:
write
in classAbstractByteArrayOutputStream
- Parameters:
in
- the input stream to read from- Returns:
- total number of bytes read from the input stream (and written to this stream)
- Throws:
IOException
- if an I/O error occurs while reading the input stream
-
size
public int size()Description copied from class:AbstractByteArrayOutputStream
Returns the current size of the byte array.- Specified by:
size
in classAbstractByteArrayOutputStream
- Returns:
- the current size of the byte array
-
reset
public void reset()- Specified by:
reset
in classAbstractByteArrayOutputStream
- See Also:
-
writeTo
Description copied from class:AbstractByteArrayOutputStream
Writes the entire contents of this byte stream to the specified output stream.- Specified by:
writeTo
in classAbstractByteArrayOutputStream
- Parameters:
out
- the output stream to write to- Throws:
IOException
- if an I/O error occurs, such as if the stream is closed- See Also:
-
toBufferedInputStream
Fetches 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:
IOException
- if an I/O error occurs.- Since:
- 2.0
-
toBufferedInputStream
Fetches 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.size
- the initial buffer size- Returns:
- A fully buffered stream.
- Throws:
IOException
- if an I/O error occurs.- Since:
- 2.5
-
toInputStream
Description copied from class:AbstractByteArrayOutputStream
Gets the current contents of this byte stream as a Input Stream. The returned stream is backed by buffers ofthis
stream, avoiding memory allocation and copy, thus saving space and time.- Specified by:
toInputStream
in classAbstractByteArrayOutputStream
- Returns:
- the current contents of this output stream.
- See Also:
-
toByteArray
public byte[] toByteArray()Description copied from class:AbstractByteArrayOutputStream
Gets the current contents of this byte stream as a byte array. The result is independent of this stream.- Specified by:
toByteArray
in classAbstractByteArrayOutputStream
- Returns:
- the current contents of this output stream, as a byte array
- See Also:
-