ByteArrayOutputStream
open class ByteArrayOutputStream : OutputStream
kotlin.Any | ||
↳ | java.io.OutputStream | |
↳ | java.io.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
.
Summary
Public constructors | |
---|---|
Creates a new |
|
ByteArrayOutputStream(size: Int) Creates a new |
Public methods | |
---|---|
open Unit |
close() Closing a |
open Unit |
reset() Resets the |
open Int |
size() Returns the current size of the buffer. |
open ByteArray |
Creates a newly allocated byte array. |
open String |
toString() Converts the buffer's contents into a string decoding bytes using the platform's default character set. |
open String |
Converts the buffer's contents into a string by decoding the bytes using the named |
open String |
Converts the buffer's contents into a string by decoding the bytes using the specified |
open String |
Creates a newly allocated string. |
open Unit |
Writes the specified byte to this |
open Unit |
Writes |
open Unit |
writeBytes(b: ByteArray!) Writes the complete contents of the specified byte array to this |
open Unit |
writeTo(out: OutputStream) Writes the complete contents of this |
Inherited functions | |
---|---|
Properties | |
---|---|
ByteArray |
The buffer where data is stored. |
Int |
The number of valid bytes in the buffer. |
Public constructors
ByteArrayOutputStream
ByteArrayOutputStream()
Creates a new ByteArrayOutputStream
. The buffer capacity is initially 32 bytes, though its size increases if necessary.
ByteArrayOutputStream
ByteArrayOutputStream(size: Int)
Creates a new ByteArrayOutputStream
, with a buffer capacity of the specified size, in bytes.
Parameters | |
---|---|
size |
Int: the initial size. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if size is negative. |
Public methods
close
open fun close(): Unit
Closing a ByteArrayOutputStream
has no effect. The methods in this class can be called after the stream has been closed without generating an IOException
.
Exceptions | |
---|---|
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
if an I/O error occurs. |
reset
open fun reset(): Unit
Resets the count
field of this ByteArrayOutputStream
to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.
See Also
size
open fun size(): Int
Returns the current size of the buffer.
Return | |
---|---|
Int |
the value of the count field, which is the number of valid bytes in this output stream. |
See Also
toByteArray
open fun toByteArray(): ByteArray
Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
Return | |
---|---|
ByteArray |
the current contents of this output stream, as a byte array. |
See Also
toString
open fun toString(): String
Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String
is a function of the character set, and hence may not be equal to the size of the buffer.
This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The java.nio.charset.CharsetDecoder class should be used when more control over the decoding process is required.
Return | |
---|---|
String |
String decoded from the buffer's contents. |
toString
open fun toString(charsetName: String): String
Converts the buffer's contents into a string by decoding the bytes using the named charset
.
This method is equivalent to toString(charset)
that takes a charset
.
An invocation of this method of the form
<code>ByteArrayOutputStream b = ... b.toString("UTF-8") </code>
<code>ByteArrayOutputStream b = ... b.toString(StandardCharsets.UTF_8) </code>
Parameters | |
---|---|
charsetName |
String: the name of a supported charset |
Return | |
---|---|
String |
String decoded from the buffer's contents. |
Exceptions | |
---|---|
java.io.UnsupportedEncodingException |
If the named charset is not supported |
toString
open fun toString(charset: Charset): String
Converts the buffer's contents into a string by decoding the bytes using the specified charset
. The length of the new String
is a function of the charset, and hence may not be equal to the length of the byte array.
This method always replaces malformed-input and unmappable-character sequences with the charset's default replacement string. The class should be used when more control over the decoding process is required.
Parameters | |
---|---|
charset |
Charset: the charset to be used to decode the bytes |
Return | |
---|---|
String |
String decoded from the buffer's contents. |
toString
open funtoString(hibyte: Int): String
Deprecated: This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via the toString(java.lang.String)
or toString(java.nio.charset.Charset)
method, which takes an encoding-name or charset argument, or the toString()
method, which uses the platform's default character encoding.
Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that:
<code>c == (char)(((hibyte & 0xff) << 8) | (b & 0xff)) </code>
Parameters | |
---|---|
hibyte |
Int: the high byte of each resulting Unicode character. |
Return | |
---|---|
String |
the current contents of the output stream, as a string. |
write
open fun write(b: Int): Unit
Writes the specified byte to this ByteArrayOutputStream
.
Parameters | |
---|---|
b |
Int: the byte to be written. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed. |
write
open fun write(
b: ByteArray,
off: Int,
len: Int
): Unit
Writes len
bytes from the specified byte array starting at offset off
to this ByteArrayOutputStream
.
Parameters | |
---|---|
b |
ByteArray: the data. |
off |
Int: the start offset in the data. |
len |
Int: the number of bytes to write. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed. |
java.lang.NullPointerException |
if b is null . |
java.lang.IndexOutOfBoundsException |
if off is negative, len is negative, or len is greater than b.length - off |
writeBytes
open fun writeBytes(b: ByteArray!): Unit
Writes the complete contents of the specified byte array to this ByteArrayOutputStream
.
Parameters | |
---|---|
b |
ByteArray!: the data. |
Exceptions | |
---|---|
java.lang.NullPointerException |
if b is null . |
writeTo
open fun writeTo(out: OutputStream): Unit
Writes the complete contents of this ByteArrayOutputStream
to the specified output stream argument, as if by calling the output stream's write method using out.write(buf, 0, count)
.
Parameters | |
---|---|
out |
OutputStream: the output stream to which to write the data. |
Exceptions | |
---|---|
java.lang.NullPointerException |
if out is null . |
java.io.IOException |
if an I/O error occurs. |