Most visited

Recently visited

Results for

Summary: Ctors | Methods | Protected Methods | Inherited Methods

Inflater

public class Inflater
extends Object

java.lang.Object
↳	java.util.zip.Inflater

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€€";
     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
 }

See also:

Deflater

Summary

Public constructors
`Inflater(boolean nowrap)` Creates a new decompressor.
`Inflater()` Creates a new decompressor.

Public methods
`void`	`end()` Closes the decompressor and discards any unprocessed input.
`boolean`	`finished()` Returns true if the end of the compressed data stream has been reached.
`int`	`getAdler()` Returns the ADLER-32 value of the uncompressed data.
`long`	`getBytesRead()` Returns the total number of compressed bytes input so far.
`long`	`getBytesWritten()` Returns the total number of uncompressed bytes output so far.
`int`	`getRemaining()` Returns the total number of bytes remaining in the input buffer.
`int`	`getTotalIn()` Returns the total number of compressed bytes input so far.
`int`	`getTotalOut()` Returns the total number of uncompressed bytes output so far.
`int`	`inflate(byte[] b)` Uncompresses bytes into specified buffer.
`int`	`inflate(byte[] b, int off, int len)` Uncompresses bytes into specified buffer.
`boolean`	`needsDictionary()` Returns true if a preset dictionary is needed for decompression.
`boolean`	`needsInput()` Returns true if no data remains in the input buffer.
`void`	`reset()` Resets inflater so that a new set of input data can be processed.
`void`	`setDictionary(byte[] b, int off, int len)` Sets the preset dictionary to the given array of bytes.
`void`	`setDictionary(byte[] b)` Sets the preset dictionary to the given array of bytes.
`void`	`setInput(byte[] b, int off, int len)` Sets input data for decompression.
`void`	`setInput(byte[] b)` Sets input data for decompression.

Protected methods
`void`	`finalize()` Closes the decompressor when garbage is collected.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

Inflater

public Inflater (boolean nowrap)

Creates a new decompressor. If the parameter 'nowrap' is true then the ZLIB header and checksum fields will not be used. This provides compatibility with the compression format used by both GZIP and PKZIP.

Note: When using the 'nowrap' option it is also necessary to provide an extra "dummy" byte as input. This is required by the ZLIB native library in order to support certain optimizations.

Parameters
`nowrap`	`boolean`: if true then support GZIP compatible compression

Inflater

public Inflater ()

Creates a new decompressor.

Public methods

end

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.

finished

public boolean finished ()

Returns true if the end of the compressed data stream has been reached.

Returns
`boolean`	true if the end of the compressed data stream has been reached

getAdler

public int getAdler ()

Returns the ADLER-32 value of the uncompressed data.

Returns
`int`	the ADLER-32 value of the uncompressed data

getBytesRead

public long getBytesRead ()

Returns the total number of compressed bytes input so far.

Returns
`long`	the total (non-negative) number of compressed bytes input so far

getBytesWritten

public long getBytesWritten ()

Returns the total number of uncompressed bytes output so far.

Returns
`long`	the total (non-negative) number of uncompressed bytes output so far

getRemaining

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.

Returns
`int`	the total number of bytes remaining in the input buffer

getTotalIn

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.

Returns
`int`	the total number of compressed bytes input so far

getTotalOut

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.

Returns
`int`	the total number of uncompressed bytes output so far

inflate

public int inflate (byte[] b)

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.

Parameters
`b`	`byte`: the buffer for the uncompressed data

Returns
`int`	the actual number of uncompressed bytes

Throws
`DataFormatException`	if the compressed data format is invalid

See also:

inflate

public int inflate (byte[] b, 
                int off, 
                int len)

Parameters
`b`	`byte`: the buffer for the uncompressed data
`off`	`int`: the start offset of the data
`len`	`int`: the maximum number of uncompressed bytes

Returns
`int`	the actual number of uncompressed bytes

Throws
`DataFormatException`	if the compressed data format is invalid

See also:

needsDictionary

public boolean needsDictionary ()

Returns true if a preset dictionary is needed for decompression.

Returns
`boolean`	true if a preset dictionary is needed for decompression

See also:

setDictionary(byte[])

needsInput

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.

Returns
`boolean`	true if no data remains in the input buffer

reset

public void reset ()

Resets inflater so that a new set of input data can be processed.

setDictionary

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.

Parameters
`b`	`byte`: the dictionary data bytes
`off`	`int`: the start offset of the data
`len`	`int`: the length of the data

See also:

needsDictionary()
getAdler()

setDictionary

public void setDictionary (byte[] b)

Parameters
`b`	`byte`: the dictionary data bytes

See also:

needsDictionary()
getAdler()

setInput

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.

Parameters
`b`	`byte`: the input data bytes
`off`	`int`: the start offset of the input data
`len`	`int`: the length of the input data

See also:

needsInput()

setInput

public void setInput (byte[] b)

Sets input data for decompression. Should be called whenever needsInput() returns true indicating that more input data is required.

Parameters
`b`	`byte`: the input data bytes

See also:

needsInput()

Protected methods

finalize

protected void finalize ()

Closes the decompressor when garbage is collected.

Interfaces

Classes

Exceptions

Errors

Most visited

Recently visited

Results for

Inflater

Summary

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

Inflater

Inflater

Public methods

end

finished

getAdler

getBytesRead

getBytesWritten

getRemaining

getTotalIn

getTotalOut

inflate

inflate

needsDictionary

needsInput

reset

setDictionary

setDictionary

setInput

setInput

Protected methods

finalize