InflaterInputStream (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
    - - java.util.zip.InflaterInputStream
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
GZIPInputStream, ZipInputStream

public class InflaterInputStream
extends FilterInputStream
This class implements a stream filter for uncompressing data in the "deflate" compression format. It is also used as the basis for other decompression filters, such as GZIPInputStream.
See Also:
Inflater

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf Input buffer for decompression.
protected Inflater	inf Decompressor for this stream.
protected int	len Length of input buffer.

   * ### Fields inherited from class java.io.[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")  
   `[in](../../../java/io/FilterInputStream.html#in)`

Constructor Summary

Constructors

Constructor and Description
InflaterInputStream(InputStream in) Creates a new input stream with a default decompressor and buffer size.
InflaterInputStream(InputStream in,Inflater inf) Creates a new input stream with the specified decompressor and a default buffer size.
InflaterInputStream(InputStream in,Inflater inf, int size) Creates a new input stream with the specified decompressor and buffer size.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns 0 after EOF has been reached, otherwise always return 1.
void	close() Closes this input stream and releases any system resources associated with the stream.
protected void	fill() Fills input buffer with more data to decompress.
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark andreset methods.
int	read() Reads a byte of uncompressed data.
int	read(byte[] b, int off, int len) Reads uncompressed data into an array of bytes.
void	reset() Repositions this stream to the position at the time themark method was last called on this input stream.
long	skip(long n) Skips specified number of bytes of uncompressed data.

   * ### Methods inherited from class java.io.[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")  
   `[read](../../../java/io/FilterInputStream.html#read%28byte[]%29)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Field Detail

 * #### inf  
 protected [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") inf  
 Decompressor for this stream.  
 * #### buf  
 protected byte[] buf  
 Input buffer for decompression.  
 * #### len  
 protected int len  
 Length of input buffer.

Constructor Detail

* #### InflaterInputStream  
public InflaterInputStream([InputStream](../../../java/io/InputStream.html "class in java.io") in,  
                   [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") inf,  
                   int size)  
Creates a new input stream with the specified decompressor and buffer size.  
Parameters:  
`in` \- the input stream  
`inf` \- the decompressor ("inflater")  
`size` \- the input buffer size  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size is <= 0  
* #### InflaterInputStream  
public InflaterInputStream([InputStream](../../../java/io/InputStream.html "class in java.io") in,  
                   [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") inf)  
Creates a new input stream with the specified decompressor and a default buffer size.  
Parameters:  
`in` \- the input stream  
`inf` \- the decompressor ("inflater")  
* #### InflaterInputStream  
public InflaterInputStream([InputStream](../../../java/io/InputStream.html "class in java.io") in)  
Creates a new input stream with a default decompressor and buffer size.  
Parameters:  
`in` \- the input stream

Method Detail

* #### read  
public int read()  
         throws [IOException](../../../java/io/IOException.html "class in java.io")  
Reads a byte of uncompressed data. This method will block until enough input is available for decompression.  
**Overrides:**  
`[read](../../../java/io/FilterInputStream.html#read%28%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Returns:  
the byte read, or -1 if end of compressed input is reached  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
See Also:  
[FilterInputStream.in](../../../java/io/FilterInputStream.html#in)  
* #### read  
public int read(byte[] b,  
       int off,  
       int len)  
         throws [IOException](../../../java/io/IOException.html "class in java.io")  
Reads uncompressed data into an array of bytes. If `len` is not zero, the method will block until some input can be decompressed; otherwise, no bytes are read and `0` is returned.  
**Overrides:**  
`[read](../../../java/io/FilterInputStream.html#read%28byte[],%20int,%20int%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Parameters:  
`b` \- the buffer into which the data is read  
`off` \- the start offset in the destination array `b`  
`len` \- the maximum number of bytes read  
Returns:  
the actual number of bytes read, or -1 if the end of the compressed input is reached or a preset dictionary is needed  
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`  
`[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a ZIP format error has occurred  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
See Also:  
[FilterInputStream.in](../../../java/io/FilterInputStream.html#in)  
* #### available  
public int available()  
              throws [IOException](../../../java/io/IOException.html "class in java.io")  
Returns 0 after EOF has been reached, otherwise always return 1.  
 Programs should not count on this method to return the actual number of bytes that could be read without blocking.  
**Overrides:**  
`[available](../../../java/io/FilterInputStream.html#available%28%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Returns:  
1 before EOF and 0 after EOF.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
* #### skip  
public long skip(long n)  
          throws [IOException](../../../java/io/IOException.html "class in java.io")  
Skips specified number of bytes of uncompressed data.  
**Overrides:**  
`[skip](../../../java/io/FilterInputStream.html#skip%28long%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Parameters:  
`n` \- the number of bytes to skip  
Returns:  
the actual number of bytes skipped.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if n < 0  
* #### 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.  
**Specified by:**  
`[close](../../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../../java/lang/AutoCloseable.html "interface in java.lang")`  
**Overrides:**  
`[close](../../../java/io/FilterInputStream.html#close%28%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
See Also:  
[FilterInputStream.in](../../../java/io/FilterInputStream.html#in)  
* #### fill  
protected void fill()  
             throws [IOException](../../../java/io/IOException.html "class in java.io")  
Fills input buffer with more data to decompress.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
* #### markSupported  
public boolean markSupported()  
Tests if this input stream supports the `mark` and`reset` methods. The `markSupported` method of `InflaterInputStream` returns`false`.  
**Overrides:**  
`[markSupported](../../../java/io/FilterInputStream.html#markSupported%28%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Returns:  
a `boolean` indicating if this stream type supports the `mark` and `reset` methods.  
See Also:  
[InputStream.mark(int)](../../../java/io/InputStream.html#mark%28int%29), [InputStream.reset()](../../../java/io/InputStream.html#reset%28%29)  
* #### mark  
public void mark(int readlimit)  
Marks the current position in this input stream.  
 The `mark` method of `InflaterInputStream` does nothing.  
**Overrides:**  
`[mark](../../../java/io/FilterInputStream.html#mark%28int%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Parameters:  
`readlimit` \- the maximum limit of bytes that can be read before the mark position becomes invalid.  
See Also:  
[InputStream.reset()](../../../java/io/InputStream.html#reset%28%29)  
* #### reset  
public void reset()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Repositions this stream to the position at the time the`mark` method was last called on this input stream.  
 The method `reset` for class`InflaterInputStream` does nothing except throw an`IOException`.  
**Overrides:**  
`[reset](../../../java/io/FilterInputStream.html#reset%28%29)` in class `[FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")`  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if this method is invoked.  
See Also:  
[InputStream.mark(int)](../../../java/io/InputStream.html#mark%28int%29), [IOException](../../../java/io/IOException.html "class in java.io")

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

InflaterInputStream (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail