Inflater

See also:

• Deflater

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.

Inflater

public Inflater ()

Creates a new decompressor.

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

getAdler

public int getAdler ()

Returns the ADLER-32 value of the uncompressed data.

getBytesRead

public long getBytesRead ()

Returns the total number of compressed bytes input so far.

getBytesWritten

public long getBytesWritten ()

Returns the total 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.

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.

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.

inflate

public int inflate (byte[] output)

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.

The remaining byte count will be reduced by the number of consumed input bytes. If the setInput(java.nio.ByteBuffer) method was called to provide a buffer for input, the input buffer's position will be advanced the number of consumed bytes.

These byte totals, as well as the total bytes read and the total bytes written values, will be updated even in the event that a DataFormatException is thrown to reflect the amount of data consumed and produced before the exception occurred.

inflate

public int inflate (ByteBuffer output)

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.

On success, the position of the given output byte buffer will be advanced by as many bytes as were produced by the operation, which is equal to the number returned by this method. Note that the position of the output buffer will be advanced even in the event that a DataFormatException is thrown.

The remaining byte count will be reduced by the number of consumed input bytes. If the setInput(java.nio.ByteBuffer) method was called to provide a buffer for input, the input buffer's position will be advanced the number of consumed bytes.

These byte totals, as well as the total bytes read and the total bytes written values, will be updated even in the event that a DataFormatException is thrown to reflect the amount of data consumed and produced before the exception occurred.

inflate

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

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.

If the setInput(java.nio.ByteBuffer) method was called to provide a buffer for input, the input buffer's position will be advanced by the number of bytes consumed by this operation, even in the event that a DataFormatException is thrown.

The remaining byte count will be reduced by the number of consumed input bytes. If the setInput(java.nio.ByteBuffer) method was called to provide a buffer for input, the input buffer's position will be advanced the number of consumed bytes.

These byte totals, as well as the total bytes read and the total bytes written values, will be updated even in the event that a DataFormatException is thrown to reflect the amount of data consumed and produced before the exception occurred.

needsDictionary

public boolean needsDictionary ()

Returns true if a preset dictionary is needed for decompression.

needsInput

public boolean needsInput ()

Returns true if no data remains in the input buffer. This can be used to determine if one of the setInput() methods should be called in order to provide more input.

reset

public void reset ()

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

setDictionary

public void setDictionary (ByteBuffer dictionary)

Sets the preset dictionary to the bytes in the given buffer. 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.

The bytes in given byte buffer will be fully consumed by this method. On return, its position will equal its limit.

setDictionary

public void setDictionary (byte[] dictionary, 
                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.

setDictionary

public void setDictionary (byte[] dictionary)

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.

setInput

public void setInput (ByteBuffer input)

Sets input data for decompression.

One of the setInput() methods should be called whenever needsInput() returns true indicating that more input data is required.

The given buffer's position will be advanced as inflate operations are performed, up to the buffer's limit. The input buffer may be modified (refilled) between inflate operations; doing so is equivalent to creating a new buffer and setting it with this method.

Modifying the input buffer's contents, position, or limit concurrently with an inflate operation will result in undefined behavior, which may include incorrect operation results or operation failure.

setInput

public void setInput (byte[] input, 
                int off, 
                int len)

Sets input data for decompression.

One of the setInput() methods should be called whenever needsInput() returns true indicating that more input data is required.

setInput

public void setInput (byte[] input)

Sets input data for decompression.

One of the setInput() methods should be called whenever needsInput() returns true indicating that more input data is required.