SequenceInputStream (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.io.InputStream
  • • java.io.SequenceInputStream

• All Implemented Interfaces:
  [Closeable](../../java/io/Closeable.html "interface in java.io"), [AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")

public class SequenceInputStream
extends InputStream
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:
1.0

• • Constructor Summary

  Constructors

  Constructor	Description
  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.
  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.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  int	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.
  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​(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](../../java/io/InputStream.html "class in java.io")  
     `[mark](../../java/io/InputStream.html#mark-int-), [markSupported](../../java/io/InputStream.html#markSupported--), [read](../../java/io/InputStream.html#read-byte:A-), [readAllBytes](../../java/io/InputStream.html#readAllBytes--), [readNBytes](../../java/io/InputStream.html#readNBytes-byte:A-int-int-), [reset](../../java/io/InputStream.html#reset--), [skip](../../java/io/InputStream.html#skip-long-), [transferTo](../../java/io/InputStream.html#transferTo-java.io.OutputStream-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [toString](../../java/lang/Object.html#toString--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### SequenceInputStream  
     public SequenceInputStream​([Enumeration](../../java/util/Enumeration.html "interface in java.util")<? extends [InputStream](../../java/io/InputStream.html "class in java.io")> 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` \- an enumeration of input streams.  
     See Also:  
     [Enumeration](../../java/util/Enumeration.html "interface in java.util")  
     * #### SequenceInputStream  
     public SequenceInputStream​([InputStream](../../java/io/InputStream.html "class in java.io") s1,  
                                [InputStream](../../java/io/InputStream.html "class in java.io") 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](../../java/io/IOException.html "class in java.io")  
    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.  
    Overrides:  
    `[available](../../java/io/InputStream.html#available--)` in class `[InputStream](../../java/io/InputStream.html "class in java.io")`  
    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()](../../java/io/SequenceInputStream.html#close--) method  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    Since:  
    1.1  
    * #### read  
    public int read​()  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
    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.  
    Specified by:  
    `[read](../../java/io/InputStream.html#read--)` 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](../../java/io/IOException.html "class in java.io")  
    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.  
    Overrides:  
    `[read](../../java/io/InputStream.html#read-byte:A-int-int-)` 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 in array `b` at which the data is written.  
    `len` \- the maximum number of bytes read.  
    Returns:  
    int the number of bytes read.  
    Throws:  
    `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If `b` is `null`.  
    `[IndexOutOfBoundsException](../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- If `off` is negative,`len` is negative, or `len` is greater than`b.length - off`  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [InputStream.read()](../../java/io/InputStream.html#read--)  
    * #### close  
    public void close​()  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    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.  
    Specified by:  
    `[close](../../java/lang/AutoCloseable.html#close--)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
    Specified by:  
    `[close](../../java/io/Closeable.html#close--)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
    Overrides:  
    `[close](../../java/io/InputStream.html#close--)` 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.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.