class AssetInputStream : InputStream
Summary
| Public methods |
| Int |
|
| Unit |
|
| Unit |
|
| Boolean |
|
| Int |
|
| Int |
Reads some number of bytes from the input stream and stores them into the buffer array b.
|
| Int |
Reads up to len bytes of data from the input stream into an array of bytes.
|
| Unit |
|
| Long |
|
| Inherited functions |
From class InputStream
InputStream! |
nullInputStream()
Returns a new InputStream that reads no bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.
While the stream is open, the available(), read(), read(byte[]), read(byte[], int, int), readAllBytes(), readNBytes(byte[], int, int), readNBytes(int), skip(long), skipNBytes(long), and transferTo() methods all behave as if end of stream has been reached. After the stream has been closed, these methods all throw IOException.
The markSupported() method returns false. The mark() method does nothing, and the reset() method throws IOException.
|
ByteArray! |
readAllBytes()
Reads all remaining bytes from the input stream. This method blocks until all remaining bytes have been read and end of stream is detected, or an exception is thrown. This method does not close the input stream.
When this stream reaches end of stream, further invocations of this method will return an empty byte array.
Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading input streams with large amounts of data.
The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
|
ByteArray! |
readNBytes(len: Int)
Reads up to a specified number of bytes from the input stream. This method blocks until the requested number of bytes has been read, end of stream is detected, or an exception is thrown. This method does not close the input stream.
The length of the returned array equals the number of bytes read from the stream. If len is zero, then no bytes are read and an empty byte array is returned. Otherwise, up to len bytes are read from the stream. Fewer than len bytes may be read if end of stream is encountered.
When this stream reaches end of stream, further invocations of this method will return an empty byte array.
Note that this method is intended for simple cases where it is convenient to read the specified number of bytes into a byte array. The total amount of memory allocated by this method is proportional to the number of bytes read from the stream which is bounded by len. Therefore, the method may be safely called with very large values of len provided sufficient memory is available.
The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
|
Int |
readNBytes(b: ByteArray!, off: Int, len: Int)
Reads the requested number of bytes from the input stream into the given byte array. This method blocks until len bytes of input data have been read, end of stream is detected, or an exception is thrown. The number of bytes actually read, possibly zero, is returned. This method does not close the input stream.
In the case where end of stream is reached before len bytes have been read, then the actual number of bytes read will be returned. When this stream reaches end of stream, further invocations of this method will return zero.
If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read up to len bytes.
The first byte read is stored into element b[off], the next one in to b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k ] through b[off+len-1] unaffected.
The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes of b have been updated with data from the input stream. Consequently the input stream and b may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
|
Unit |
skipNBytes(n: Long)
Skips over and discards exactly n bytes of data from this input stream. If n is zero, then no bytes are skipped. If n is negative, then no bytes are skipped. Subclasses may handle the negative value differently.
This method blocks until the requested number of bytes has been skipped, end of file is reached, or an exception is thrown.
If end of stream is reached before the stream is at the desired position, then an EOFException is thrown.
If an I/O error occurs, then the input stream may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.
|
Long |
transferTo(out: OutputStream!)
Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. On return, this input stream will be at end of stream. This method does not close either stream.
This method may block indefinitely reading from the input stream, or writing to the output stream. The behavior for the case where the input and/or output stream is asynchronously closed, or the thread interrupted during the transfer, is highly input and output stream specific, and therefore not specified.
If an I/O error occurs reading from the input stream or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the input stream may not be at end of stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.
|
|
Public methods
available
fun available(): Int
| Return |
Int |
an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream. |
| Exceptions |
java.io.IOException |
if an I/O error occurs. |
close
fun close(): Unit
| Exceptions |
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
if an I/O error occurs. |
mark
fun mark(readlimit: Int): Unit
| Parameters |
readlimit |
Int: the maximum limit of bytes that can be read before the mark position becomes invalid. |
markSupported
fun markSupported(): Boolean
| Return |
Boolean |
true if this stream instance supports the mark and reset methods; false otherwise. |
read
fun read(): Int
| Return |
Int |
the next byte of data, or -1 if the end of the stream is reached. |
| Exceptions |
java.io.IOException |
if an I/O error occurs. |
read
fun read(b: ByteArray): Int
Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.
If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b.
The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
The read(b) method for class InputStream has the same effect as:
<code>read(b, 0, b.length) </code>
| Parameters |
b |
ByteArray: This value cannot be null. |
| Return |
Int |
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached. |
| Exceptions |
java.io.IOException |
If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs. |
java.lang.NullPointerException |
if b is null. |
read
fun read(
b: ByteArray,
off: Int,
len: Int
): Int
Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.
This method blocks until input data is available, end of file is detected, or an exception is thrown.
If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.
The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.
In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.
The read(b, off, len) method for class InputStream simply calls the method read() repeatedly. If the first such call results in an IOException, that exception is returned from the call to the read(b, off, len) method. If any subsequent call to read() results in a IOException, the exception is caught and treated as if it were end of file; the bytes read up to that point are stored into b and the number of bytes read before the exception occurred is returned. The default implementation of this method blocks until the requested amount of input data len has been read, end of file is detected, or an exception is thrown. Subclasses are encouraged to provide a more efficient implementation of this method.
| Parameters |
b |
ByteArray: This value cannot be null. |
off |
Int: the start offset in array b at which the data is written. |
len |
Int: the maximum number of bytes to read. |
| Return |
Int |
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached. |
| Exceptions |
java.io.IOException |
If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs. |
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 |
reset
fun reset(): Unit
| Exceptions |
java.io.IOException |
if this stream has not been marked or if the mark has been invalidated. |
skip
fun skip(n: Long): Long
| Parameters |
n |
Long: the number of bytes to be skipped. |
| Return |
Long |
the actual number of bytes skipped which might be zero. |
| Exceptions |
java.io.IOException |
if an I/O error occurs. |
Protected methods
finalize
protected fun finalize(): Unit
| Exceptions |
java.lang.Throwable |
the Exception raised by this method |
