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 -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new byte array output stream.ByteArrayOutputStream(int size) Constructs a new byte array output stream, with a buffer capacity of the specified size, in bytes. -
Method Summary
Modifier and TypeMethodDescriptionvoidreset()Seereset().intsize()Returns the current size of the byte array.static InputStreamtoBufferedInputStream(InputStream input) Fetches entire contents of anInputStreamand represent same data as result InputStream.static InputStreamtoBufferedInputStream(InputStream input, int size) Fetches entire contents of anInputStreamand 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 an Input Stream.voidwrite(byte[] b, int off, int len) voidwrite(int b) intwrite(InputStream in) Writes the entire contents of the specified input stream to this byte stream.voidwriteTo(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, writeToImplMethods inherited from class java.io.OutputStream
flush, write
-
Constructor Details
-
ByteArrayOutputStream
public ByteArrayOutputStream()Constructs a new byte array output stream. The buffer capacity is initially 1024 bytes, though its size increases if necessary. -
ByteArrayOutputStream
Constructs 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
-
toBufferedInputStream
Fetches entire contents of anInputStreamand 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 anInputStreamand 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
-
reset
Description copied from class:AbstractByteArrayOutputStreamSeereset().- Specified by:
resetin classAbstractByteArrayOutputStream- See Also:
-
size
Description copied from class:AbstractByteArrayOutputStreamReturns the current size of the byte array.- Specified by:
sizein classAbstractByteArrayOutputStream- Returns:
- the current size of the byte array
-
toByteArray
Description copied from class:AbstractByteArrayOutputStreamGets the current contents of this byte stream as a byte array. The result is independent of this stream.- Specified by:
toByteArrayin classAbstractByteArrayOutputStream- Returns:
- the current contents of this output stream, as a byte array
- See Also:
-
toInputStream
Description copied from class:AbstractByteArrayOutputStreamGets the current contents of this byte stream as an Input Stream. The returned stream is backed by buffers ofthisstream, avoiding memory allocation and copy, thus saving space and time.- Specified by:
toInputStreamin classAbstractByteArrayOutputStream- Returns:
- the current contents of this output stream.
- See Also:
-
write
- Specified by:
writein classAbstractByteArrayOutputStream
-
write
Description copied from class:AbstractByteArrayOutputStreamWrites the entire contents of the specified input stream to this byte stream. Bytes from the input stream are read directly into the internal buffer of this stream.- Specified by:
writein 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
-
write
- Specified by:
writein classAbstractByteArrayOutputStream
-
writeTo
Description copied from class:AbstractByteArrayOutputStreamWrites the entire contents of this byte stream to the specified output stream.- Specified by:
writeToin 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:
-