Home » openjdk-7 » java » util » zip » [javadoc | source]
java.util.zip
public class: Inflater [javadoc | source]
java.lang.Object
   java.util.zip.Inflater

Direct Known Subclasses:
    InflatingDecompressor

This class provides support for general purpose decompression using the popular ZLIB compression library. The ZLIB compression library was initially developed as part of the PNG graphics standard and is not protected by patents. It is fully described in the specifications at the java.util.zip package description.

The following code fragment demonstrates a trivial compression and decompression of a string using Deflater and Inflater.

try {
    // Encode a String into bytes
    String inputString = "blahblahblah\u20AC\u20AC";
    byte[] input = inputString.getBytes("UTF-8");

    // Compress the bytes
    byte[] output = new byte[100];
    Deflater compresser = new Deflater();
    compresser.setInput(input);
    compresser.finish();
    int compressedDataLength = compresser.deflate(output);

    // Decompress the bytes
    Inflater decompresser = new Inflater();
    decompresser.setInput(output, 0, compressedDataLength);
    byte[] result = new byte[100];
    int resultLength = decompresser.inflate(result);
    decompresser.end();

    // Decode the bytes into a String
    String outputString = new String(result, 0, resultLength, "UTF-8");
} catch(java.io.UnsupportedEncodingException ex) {
    // handle
} catch (java.util.zip.DataFormatException ex) {
    // handle
}
Constructor:
 public Inflater() 
 public Inflater(boolean nowrap) 
Method from java.util.zip.Inflater Summary:
end,   ended,   finalize,   finished,   getAdler,   getBytesRead,   getBytesWritten,   getRemaining,   getTotalIn,   getTotalOut,   inflate,   inflate,   needsDictionary,   needsInput,   reset,   setDictionary,   setDictionary,   setInput,   setInput
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.zip.Inflater Detail:
 public  void end() 
    Closes the decompressor and discards any unprocessed input. This method should be called when the decompressor is no longer being used, but will also be called automatically by the finalize() method. Once this method is called, the behavior of the Inflater object is undefined.
 boolean ended() 
 protected  void finalize() 
    Closes the decompressor when garbage is collected.
 public boolean finished() 
    Returns true if the end of the compressed data stream has been reached.
 public int getAdler() 
    Returns the ADLER-32 value of the uncompressed data.
 public long getBytesRead() 
    Returns the total number of compressed bytes input so far.

 public long getBytesWritten() 
    Returns the total number of uncompressed bytes output so far.

 public int getRemaining() 
    Returns the total number of bytes remaining in the input buffer. This can be used to find out what bytes still remain in the input buffer after decompression has finished.
 public int getTotalIn() 
    Returns the total number of compressed bytes input so far.

    Since the number of bytes may be greater than Integer.MAX_VALUE, the #getBytesRead() method is now the preferred means of obtaining this information.

 public int getTotalOut() 
    Returns the total number of uncompressed bytes output so far.

    Since the number of bytes may be greater than Integer.MAX_VALUE, the #getBytesWritten() method is now the preferred means of obtaining this information.

 public int inflate(byte[] b) throws DataFormatException 
    Uncompresses bytes into specified buffer. Returns actual number of bytes uncompressed. A return value of 0 indicates that needsInput() or needsDictionary() should be called in order to determine if more input data or a preset dictionary is required. In the latter case, getAdler() can be used to get the Adler-32 value of the dictionary required.
 public int inflate(byte[] b,
    int off,
    int len) throws DataFormatException 
    Uncompresses bytes into specified buffer. Returns actual number of bytes uncompressed. A return value of 0 indicates that needsInput() or needsDictionary() should be called in order to determine if more input data or a preset dictionary is required. In the latter case, getAdler() can be used to get the Adler-32 value of the dictionary required.
 public boolean needsDictionary() 
    Returns true if a preset dictionary is needed for decompression.
 public boolean needsInput() 
    Returns true if no data remains in the input buffer. This can be used to determine if #setInput should be called in order to provide more input.
 public  void reset() 
    Resets inflater so that a new set of input data can be processed.
 public  void setDictionary(byte[] b) 
    Sets the preset dictionary to the given array of bytes. Should be called when inflate() returns 0 and needsDictionary() returns true indicating that a preset dictionary is required. The method getAdler() can be used to get the Adler-32 value of the dictionary needed.
 public  void setDictionary(byte[] b,
    int off,
    int len) 
    Sets the preset dictionary to the given array of bytes. Should be called when inflate() returns 0 and needsDictionary() returns true indicating that a preset dictionary is required. The method getAdler() can be used to get the Adler-32 value of the dictionary needed.
 public  void setInput(byte[] b) 
    Sets input data for decompression. Should be called whenever needsInput() returns true indicating that more input data is required.
 public  void setInput(byte[] b,
    int off,
    int len) 
    Sets input data for decompression. Should be called whenever needsInput() returns true indicating that more input data is required.