SequenceInputStream
open class SequenceInputStream : InputStream
kotlin.Any | ||
↳ | java.io.InputStream | |
↳ | java.io.SequenceInputStream |
A SequenceInputStream
represents the logical concatenation of other input streams. It starts out with an ordered collection of input streams and reads from the first one until end of file is reached, whereupon it reads from the second one, and so on, until end of file is reached on the last of the contained input streams.
Summary
Public constructors | |
---|---|
SequenceInputStream(e: Enumeration<out InputStream!>!) Initializes a newly created |
|
SequenceInputStream(s1: InputStream!, s2: InputStream!) Initializes a newly created |
Public methods | |
---|---|
open Int |
Returns an estimate of the number of bytes that can be read (or skipped over) from the current underlying input stream without blocking by the next invocation of a method for the current underlying input stream. |
open Unit |
close() Closes this input stream and releases any system resources associated with the stream. |
open Int |
read() Reads the next byte of data from this input stream. |
open Int |
Reads up to |
Inherited functions | |
---|---|
Public constructors
SequenceInputStream
SequenceInputStream(e: Enumeration<out InputStream!>!)
Initializes a newly created SequenceInputStream
by remembering the argument, which must be an Enumeration
that produces objects whose run-time type is InputStream
. The input streams that are produced by the enumeration will be read, in order, to provide the bytes to be read from this SequenceInputStream
. After each input stream from the enumeration is exhausted, it is closed by calling its close
method.
Parameters | |
---|---|
e |
Enumeration<out InputStream!>!: an enumeration of input streams. |
See Also
SequenceInputStream
SequenceInputStream(
s1: InputStream!,
s2: InputStream!)
Initializes a newly created SequenceInputStream
by remembering the two arguments, which will be read in order, first s1
and then s2
, to provide the bytes to be read from this SequenceInputStream
.
Parameters | |
---|---|
s1 |
InputStream!: the first input stream to read. |
s2 |
InputStream!: the second input stream to read. |
Public methods
available
open fun available(): Int
Returns an estimate of the number of bytes that can be read (or skipped over) from the current underlying input stream without blocking by the next invocation of a method for the current underlying input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.
This method simply calls available
of the current underlying input stream and returns the result.
Return | |
---|---|
Int |
an estimate of the number of bytes that can be read (or skipped over) from the current underlying input stream without blocking or 0 if this input stream has been closed by invoking its #close() method |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs. |
java.io.IOException |
if an I/O error occurs. |
close
open fun close(): Unit
Closes this input stream and releases any system resources associated with the stream. A closed SequenceInputStream
cannot perform input operations and cannot be reopened.
If this stream was created from an enumeration, all remaining elements are requested from the enumeration and closed before the close
method returns.
Exceptions | |
---|---|
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
if an I/O error occurs. |
java.io.IOException |
if an I/O error occurs. |
read
open fun read(): Int
Reads the next byte of data from this input stream. The byte is returned as an int
in the range 0
to 255
. If no byte is available because the end of the stream has been reached, the value -1
is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
This method tries to read one character from the current substream. If it reaches the end of the stream, it calls the close
method of the current substream and begins reading from the next substream.
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. |
java.io.IOException |
if an I/O error occurs. |
read
open fun read(
b: ByteArray!,
off: Int,
len: Int
): Int
Reads up to len
bytes of data from this input stream into an array of bytes. If len
is not zero, the method blocks until at least 1 byte of input is available; otherwise, no bytes are read and 0
is returned.
The read
method of SequenceInputStream
tries to read the data from the current substream. If it fails to read any characters because the substream has reached the end of the stream, it calls the close
method of the current substream and begins reading from the next substream.
Parameters | |
---|---|
b |
ByteArray!: the buffer into which the data is read. |
off |
Int: the start offset in array b at which the data is written. |
len |
Int: the maximum number of bytes read. |
Return | |
---|---|
Int |
int the number of bytes read. |
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 |
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 |
java.io.IOException |
if an I/O error occurs. |