SequenceInputStream (Java 2 Platform SE 5.0) (original) (raw)

java.lang.Object extended by java.io.InputStream java.io.SequenceInputStream

All Implemented Interfaces:

public class 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.

Since:

JDK1.0

Constructor Summary
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.
[SequenceInputStream](../../java/io/SequenceInputStream.html#SequenceInputStream%28java.io.InputStream, java.io.InputStream%29)(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.

Method Summary
int	available() Returns the number of bytes available on the current stream.
void	close() Closes this input stream and releases any system resources associated with the stream.
int	read() Reads the next byte of data from this input stream.
int	[read](../../java/io/SequenceInputStream.html#read%28byte[], int, int%29)(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes.

Methods inherited from class java.io.InputStream
mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

SequenceInputStream

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 thisSequenceInputStream. After each input stream from the enumeration is exhausted, it is closed by calling itsclose method.

Parameters:

e - an enumeration of input streams.

See Also:

Enumeration

SequenceInputStream

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 - the first input stream to read.

s2 - the second input stream to read.

Method Detail

available

public int available() throws IOException

Returns the number of bytes available on the current stream.

Overrides:

[available](../../java/io/InputStream.html#available%28%29) in class [InputStream](../../java/io/InputStream.html "class in java.io")

Returns:

the number of bytes that can be read from this input stream without blocking.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

Since:

JDK1.1

read

public int read() throws IOException

Reads the next byte of data from this input stream. The byte is returned as an int in the range 0 to255. 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.

Specified by:

[read](../../java/io/InputStream.html#read%28%29) in class [InputStream](../../java/io/InputStream.html "class in java.io")

Returns:

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

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

read

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

Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until at least 1 byte of input is available. If the first argument is null, up to len bytes are read and discarded.

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.

Overrides:

[read](../../java/io/InputStream.html#read%28byte[], int, int%29) in class [InputStream](../../java/io/InputStream.html "class in java.io")

Parameters:

b - the buffer into which the data is read.

off - the start offset of the data.

len - the maximum number of bytes read.

Returns:

int the number of bytes read.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

See Also:

InputStream.read()

close

public void close() throws IOException

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. of InputStream .

Specified by:

[close](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Overrides:

[close](../../java/io/InputStream.html#close%28%29) in class [InputStream](../../java/io/InputStream.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.