This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.util.zip
class InflaterInputStream

java.lang.Object extended by java.io.InputStream extended by java.io.FilterInputStream extended by java.util.zip.InflaterInputStream
All Implemented Interfaces:
Closeable
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.


Field Summary
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
in
 
Constructor Summary

          Creates a new input stream with a default decompressor and buffer size.

          Creates a new input stream with the specified decompressor and a default buffer size.

          Creates a new input stream with the specified decompressor and buffer size.
 
Method Summary
 int

          Returns 0 after EOF has been reached, otherwise always return 1.
 void

          Closes this input stream and releases any system resources associated with the stream.
protected void

          Fills input buffer with more data to decompress.
 void
mark(int readlimit)

          Marks the current position in this input stream.
 boolean

          Tests if this input stream supports the mark and reset methods.
 int

          Reads a byte of uncompressed data.
 int
read(byte[] b, int off, int len)

          Reads uncompressed data into an array of bytes.
 void

          Repositions this stream to the position at the time the mark 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
available, close, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, read, reset, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buf

protected byte[] buf
Input buffer for decompression.

inf

protected Inflater inf
Decompressor for this stream.

len

protected int len
Length of input buffer.
Constructor Detail

InflaterInputStream

public InflaterInputStream(InputStream in)
Creates a new input stream with a default decompressor and buffer size.

Parameters:
in - the input stream

InflaterInputStream

public InflaterInputStream(InputStream in,
                           Inflater 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 in,
                           Inflater 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
Method Detail

available

public int available()
              throws IOException
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 in class FilterInputStream
Returns:
1 before EOF and 0 after EOF.
Throws:
IOException - if an I/O error occurs.

close

public void close()
           throws IOException
Closes this input stream and releases any system resources associated with the stream.

Overrides:
close in class FilterInputStream
Throws:
IOException - if an I/O error has occurred

fill

protected void fill()
             throws IOException
Fills input buffer with more data to decompress.

Throws:
IOException - if an I/O error has occurred

mark

public synchronized void mark(int readlimit)
Marks the current position in this input stream.

The mark method of InflaterInputStream does nothing.

Overrides:
mark in class FilterInputStream
Parameters:
readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

markSupported

public boolean markSupported()
Tests if this input stream supports the mark and reset methods. The markSupported method of InflaterInputStream returns false.

Overrides:
markSupported in class FilterInputStream
Returns:
a boolean indicating if this stream type supports the mark and reset methods.

read

public int read()
         throws IOException
Reads a byte of uncompressed data. This method will block until enough input is available for decompression.

Overrides:
read in class FilterInputStream
Returns:
the byte read, or -1 if end of compressed input is reached
Throws:
IOException - if an I/O error has occurred

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
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 in class FilterInputStream
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:
IOException - if an I/O error has occurred

reset

public synchronized void reset()
                        throws IOException
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 in class FilterInputStream
Throws:
IOException - if this method is invoked.

skip

public long skip(long n)
          throws IOException
Skips specified number of bytes of uncompressed data.

Overrides:
skip in class FilterInputStream
Parameters:
n - the number of bytes to skip
Returns:
the actual number of bytes skipped.
Throws:
IOException - if an I/O error has occurred


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.