Class AbstractByteArrayOutputStream<T extends AbstractByteArrayOutputStream<T>>
- Type Parameters:
T- The AbstractByteArrayOutputStream subclass
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
- Direct Known Subclasses:
ByteArrayOutputStream,UnsynchronizedByteArrayOutputStream
The data can be retrieved using toByteArray() and
toString().
Closing an AbstractByteArrayOutputStream has no effect. The methods in
this class can be called after the stream has been closed without
generating an IOException.
This is the base for 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
ByteArrayOutputStream.toString(int) method that has been
ignored.
- Since:
- 2.7
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static interfaceConstructor for an InputStream subclass. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected TasThis()Returns this instance typed toT.voidclose()Does nothing.protected voidneedNewBuffer(int newCount) Makes a new buffer available either by allocating a new one or re-cycling an existing one.abstract voidreset()protected voidImplements a default reset behavior.abstract intsize()Returns the current size of the byte array.abstract byte[]Gets the current contents of this byte stream as a byte array.protected byte[]Gets the current contents of this byte stream as a byte array.abstract InputStreamGets the current contents of this byte stream as an Input Stream.protected <T extends InputStream>
InputStreamtoInputStream(AbstractByteArrayOutputStream.InputStreamConstructor<T> isConstructor) Gets the current contents of this byte stream as an Input Stream.toString()Deprecated.Gets the current contents of this byte stream as a string using the specified encoding.Gets the current contents of this byte stream as a string using the specified encoding.voidwrite(byte[] b) Writesb.lengthbytes from the given byte array to this output stream.abstract voidwrite(byte[] b, int off, int len) abstract voidwrite(int b) abstract intwrite(InputStream in) Writes the entire contents of the specified input stream to this byte stream.write(CharSequence data, Charset charset) Writes the bytes for given CharSequence encoded using a Charset.protected voidwriteImpl(byte[] b, int off, int len) Writes the bytes to the byte array.protected voidwriteImpl(int b) Write a byte to byte array.protected intwriteImpl(InputStream in) Writes the entire contents of the specified input stream to this byte stream.abstract voidwriteTo(OutputStream out) Writes the entire contents of this byte stream to the specified output stream.protected voidwriteToImpl(OutputStream out) Writes the entire contents of this byte stream to the specified output stream.Methods inherited from class java.io.OutputStream
flush
-
Field Details
-
count
The total count of bytes written.
-
-
Constructor Details
-
AbstractByteArrayOutputStream
public AbstractByteArrayOutputStream()Constructs a new instance for subclasses.
-
-
Method Details
-
asThis
Returns this instance typed toT.- Returns:
- this instance
-
close
Does nothing. The methods in this class can be called after the stream has been closed without generating anIOException.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classOutputStream- Throws:
IOException- never (this method should not declare this exception but it has to now due to backwards compatibility)
-
needNewBuffer
Makes a new buffer available either by allocating a new one or re-cycling an existing one.- Parameters:
newCount- the size of the buffer if one is created
-
reset
- See Also:
-
resetImpl
Implements a default reset behavior.- See Also:
-
size
Returns the current size of the byte array.- Returns:
- the current size of the byte array
-
toByteArray
Gets the current 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:
-
toByteArrayImpl
Gets the current 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:
-
toInputStream
Gets 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.- Returns:
- the current contents of this output stream.
- Since:
- 2.5
- See Also:
-
toInputStream
protected <T extends InputStream> InputStream toInputStream(AbstractByteArrayOutputStream.InputStreamConstructor<T> isConstructor) Gets 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.- Type Parameters:
T- the type of the InputStream which makes up theSequenceInputStream.- Parameters:
isConstructor- A constructor for an InputStream which makes up theSequenceInputStream.- Returns:
- the current contents of this output stream.
- Since:
- 2.7
- See Also:
-
toString
Deprecated.UsetoString(String)insteadGets the current contents of this byte stream as a string using the virtual machine'sdefault charset. -
toString
Gets the current contents of this byte stream as a string using the specified encoding.- Parameters:
charset- the character encoding- Returns:
- the string converted from the byte array
- Since:
- 2.5
- See Also:
-
toString
Gets the current 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:
UnsupportedEncodingException- if the encoding is not supported- See Also:
-
write
Writesb.lengthbytes from the given byte array to this output stream. This has same effect aswrite(b, 0, b.length).- Overrides:
writein classOutputStream- Parameters:
b- the data.- Since:
- 2.19.0
- See Also:
-
write
- Overrides:
writein classOutputStream
-
write
Writes the bytes for given CharSequence encoded using a Charset.- Parameters:
data- The String to convert to bytes. not null.charset- TheCharseto encode theString, null means the default encoding.- Returns:
- this instance.
- Since:
- 2.19.0
-
write
Writes 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.- 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- Since:
- 1.4
-
write
- Specified by:
writein classOutputStream
-
writeImpl
Writes the bytes to the byte array.- Parameters:
b- the bytes to writeoff- The start offsetlen- The number of bytes to write
-
writeImpl
Writes 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.- 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- Since:
- 2.7
-
writeImpl
Write a byte to byte array.- Parameters:
b- the byte to write
-
writeTo
Writes the entire contents of this byte stream to the specified output stream.- 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:
-
writeToImpl
Writes the entire contents of this byte stream to the specified output stream.- 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:
-
toString(String)instead