public class Inflater extends Object
This class inflates sequences of ZLIB compressed bytes. The input byte sequence is provided in either byte array or byte buffer, via one of the setInput()
methods. The output byte sequence is written to the output byte array or byte buffer passed to the inflate()
methods.
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 }
Inflater
, the end()
method should be called explicitly. Subclasses are responsible for the cleanup of resources acquired by the subclass. Subclasses that override Object.finalize()
in order to perform cleanup should be modified to use alternative cleanup mechanisms such as Cleaner
and remove the overriding finalize
method.Constructor | Description |
---|---|
Inflater() |
Creates a new decompressor. |
Inflater |
Creates a new decompressor. |
Modifier and Type | Method | Description |
---|---|---|
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 |
Uncompresses bytes into specified buffer. |
int |
inflate |
Uncompresses bytes into specified buffer. |
int |
inflate |
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 |
Sets the preset dictionary to the given array of bytes. |
void |
setDictionary |
Sets the preset dictionary to the given array of bytes. |
void |
setDictionary |
Sets the preset dictionary to the bytes in the given buffer. |
void |
setInput |
Sets input data for decompression. |
void |
setInput |
Sets input data for decompression. |
void |
setInput |
Sets input data for decompression. |
public Inflater(boolean nowrap)
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.
nowrap
- if true then support GZIP compatible compressionpublic Inflater()
public void setInput(byte[] input, int off, int len)
One of the setInput()
methods should be called whenever needsInput()
returns true indicating that more input data is required.
input
- the input data bytesoff
- the start offset of the input datalen
- the length of the input datapublic void setInput(byte[] input)
One of the setInput()
methods should be called whenever needsInput()
returns true indicating that more input data is required.
input
- the input data bytespublic void setInput(ByteBuffer input)
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.
input
- the input data bytespublic void setDictionary(byte[] dictionary, int off, int len)
dictionary
- the dictionary data bytesoff
- the start offset of the datalen
- the length of the datapublic void setDictionary(byte[] dictionary)
dictionary
- the dictionary data bytespublic void setDictionary(ByteBuffer dictionary)
The bytes in given byte buffer will be fully consumed by this method. On return, its position will equal its limit.
dictionary
- the dictionary data bytespublic int getRemaining()
public boolean needsInput()
setInput()
methods should be called in order to provide more input.public boolean needsDictionary()
public boolean finished()
public int inflate(byte[] output, int off, int len) throws DataFormatException
If the setInput(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(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.
output
- the buffer for the uncompressed dataoff
- the start offset of the datalen
- the maximum number of uncompressed bytesDataFormatException
- if the compressed data format is invalidpublic int inflate(byte[] output) throws DataFormatException
The remaining byte count will be reduced by the number of consumed input bytes. If the setInput(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.
output
- the buffer for the uncompressed dataDataFormatException
- if the compressed data format is invalidpublic int inflate(ByteBuffer output) throws DataFormatException
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(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.
output
- the buffer for the uncompressed dataDataFormatException
- if the compressed data format is invalidReadOnlyBufferException
- if the given output buffer is read-onlypublic int getAdler()
public int getTotalIn()
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 long getBytesRead()
public int getTotalOut()
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 long getBytesWritten()
public void reset()
public void end()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/Inflater.html