OpenJDK 1.22 · java.io.SequenceInputStream · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final Enumeration<? extends InputStream>	e
private InputStream	in

Access	Constructor and Description
public	SequenceInputStream(Enumeration<? extends InputStream> an enumeration of input streams. e) Initializes a newly created `SequenceInputStream` by remembering the argument, which must be an `Enumeration` that produces objects whose run-time type is `InputStream`.
public	SequenceInputStream(InputStream the first input stream to read. s1, InputStream the second input stream to read. s2) 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`.

Method Summary

Modifier and Type	Method and Description
public int	Returns: 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 available() Overrides java.io.InputStream.available. 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.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
pack-priv final void	nextStream() Continues reading in the next stream if an EOF is reached.
private void	peekNextStream()
public int	Returns: the next byte of data, or `-1` if the end of the stream is reached. read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	Returns: the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the last contained stream has been reached. read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public long	transferTo(OutputStream the output stream, non-null out) Overrides java.io.InputStream.transferTo. Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

Inherited from java.io.InputStream:: mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes

Field Detail

e	back to summary
private final Enumeration<? extends InputStream> e

in	back to summary
private InputStream in

Constructor Detail

SequenceInputStream back to summary

SequenceInputStream	back to summary
public SequenceInputStream(Enumeration<? extends InputStream> e) 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<? extends InputStream> an enumeration of input streams. See Also `java.util.Enumeration`

public SequenceInputStream(Enumeration<? extends InputStream> e)

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<? extends InputStream>: an enumeration of input streams.

See Also

java.util.Enumeration

SequenceInputStream back to summary

SequenceInputStream	back to summary
public SequenceInputStream(InputStream s1, InputStream s2) 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 SequenceInputStream(InputStream s1, InputStream s2)

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.

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. 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. Returns: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 Annotations @Override Exceptions IOException: if an I/O error occurs. Since 1.1

public int available() throws IOException

Overrides java.io.InputStream.available.

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.

Returns: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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

Since

1.1

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. 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. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

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.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

nextStream	back to summary
pack-priv final void nextStream() throws IOException Continues reading in the next stream if an EOF is reached.

peekNextStream	back to summary
private void peekNextStream()

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value 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 byte 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. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value 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 byte 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.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If the end of the last contained stream has been reached then `-1` is returned. Otherwise, if `len` is not zero, the method blocks until at least 1 byte of input is available; if `len` is zero, 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 bytes 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:byte[] 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. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the last contained stream has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs. NullPointerException: if the end of the last contained stream has not been reached and `b` is `null`. IndexOutOfBoundsException: if the end of the last contained stream has not been reached and `off` is negative, `len` is negative, or `len` is greater than `b.length - off`

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If the end of the last contained stream has been reached then -1 is returned. Otherwise, if len is not zero, the method blocks until at least 1 byte of input is available; if len is zero, 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 bytes 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:byte[]: 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.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the last contained stream has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: if the end of the last contained stream has not been reached and b is null.
IndexOutOfBoundsException:: if the end of the last contained stream has not been reached and off is negative, len is negative, or len is greater than b.length - off

transferTo back to summary

transferTo	back to summary
public long transferTo(OutputStream out) throws IOException Overrides java.io.InputStream.transferTo. Doc from java.io.InputStream.transferTo. 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 the total number of bytes transferred is greater than Long#MAX_VALUE, then `Long.MAX_VALUE` will be returned. 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. Parameters out:OutputStream the output stream, non-null Returns:long the number of bytes transferred Annotations @Override Exceptions IOException: if an I/O error occurs when reading or writing

public long transferTo(OutputStream out) throws IOException

Overrides java.io.InputStream.transferTo.

Doc from java.io.InputStream.transferTo.

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 the total number of bytes transferred is greater than Long#MAX_VALUE, then Long.MAX_VALUE will be returned.

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.

Parameters

out:OutputStream: the output stream, non-null

Returns:long

the number of bytes transferred

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs when reading or writing

public Class SequenceInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail