This class provides support for general purpose compression using the
popular ZLIB compression library.
This class provides support for general purpose compression 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
}
Creates a new compressor with the default compression level.
Creates a new compressor with the default compression level. Compressed data will be generated in ZLIB format.
public Deflater
(int level)
Creates a new compressor using the specified compression level.
Creates a new compressor using the specified compression level. Compressed data will be generated in ZLIB format.
Parameters: - level - the compression level (0-9)
public Deflater
(int level, boolean nowrap)
Creates a new compressor using the specified compression level.
Creates a new compressor using the specified compression level. If 'nowrap' is true then the ZLIB header and checksum fields will not be used in order to support the compression format used in both GZIP and PKZIP.
Parameters: - level - the compression level (0-9)
- nowrap - if true then use GZIP compatible compression
Fills specified buffer with compressed data. Returns actual number of bytes of compressed data. A return value of 0 indicates that needsInput() should be called in order to determine if more input data is required.
Returns:
the actual number of bytes of compressed data
Parameters: - b - the buffer for the compressed data
publicsynchronized int
deflate
(byte[] b, int off, int len)
Fills specified buffer with compressed data.
Fills specified buffer with compressed data. Returns actual number of bytes of compressed data. A return value of 0 indicates that needsInput() should be called in order to determine if more input data is required.
Returns:
the actual number of bytes of compressed data
Parameters: - b - the buffer for the compressed data
- off - the start offset of the data
- len - the maximum number of bytes of compressed data
publicsynchronized void
end
()
Closes the compressor and discards any unprocessed input.
Closes the compressor and discards any unprocessed input. This method should be called when the compressor is no longer being used, but will also be called automatically by the finalize() method. Once this method is called, the behavior of the Deflater object is undefined.
protected void
finalize
()
Closes the compressor when garbage is collected.
publicsynchronized void
finish
()
When called, indicates that compression should end with the current
contents of the input buffer.
publicsynchronized boolean
finished
()
Returns true if the end of the compressed data output stream has
been reached.
Returns true if the end of the compressed data output stream has been reached.
Returns:
true if the end of the compressed data output stream has
been reached
publicsynchronized int
getAdler
()
Returns the ADLER-32 value of the uncompressed data.
Returns the ADLER-32 value of the uncompressed data.
Returns:
the ADLER-32 value of the uncompressed data
publicsynchronized long
getBytesRead
()
Returns the total number of uncompressed bytes input so far.
Returns the total number of uncompressed bytes input so far.
Returns:
the total (non-negative) number of uncompressed bytes input so far
Since:
1.5
publicsynchronized long
getBytesWritten
()
Returns the total number of compressed bytes output so far.
Returns the total number of compressed bytes output so far.
Returns:
the total (non-negative) number of compressed bytes output so far
Since:
1.5
public int
getTotalIn
()
Returns the total number of uncompressed bytes input so far.
Returns the total number of uncompressed bytes input so far.
Since the number of bytes may be greater than
Integer.MAX_VALUE, the Deflater.getBytesRead() method is now
the preferred means of obtaining this information.
Returns:
the total number of uncompressed bytes input so far
public int
getTotalOut
()
Returns the total number of compressed bytes output so far.
Returns the total number of compressed bytes output so far.
Since the number of bytes may be greater than
Integer.MAX_VALUE, the Deflater.getBytesWritten() method is now
the preferred means of obtaining this information.
Returns:
the total number of compressed bytes output so far
public boolean
needsInput
()
Returns true if the input data buffer is empty and setInput()
should be called in order to provide more input.
Returns true if the input data buffer is empty and setInput() should be called in order to provide more input.
Returns:
true if the input data buffer is empty and setInput()
should be called in order to provide more input
publicsynchronized void
reset
()
Resets deflater so that a new set of input data can be processed.
Resets deflater so that a new set of input data can be processed. Keeps current compression level and strategy settings.
public void
setDictionary
(byte[] b)
Sets preset dictionary for compression.
Sets preset dictionary for compression. A preset dictionary is used when the history buffer can be predetermined. When the data is later uncompressed with Inflater.inflate(), Inflater.getAdler() can be called in order to get the Adler-32 value of the dictionary required for decompression.
Parameters: - b - the dictionary data bytes
See Also:Inflater.inflate(byte[], int, int),
Inflater.getAdler(),
publicsynchronized void
setDictionary
(byte[] b, int off, int len)
Sets preset dictionary for compression.
Sets preset dictionary for compression. A preset dictionary is used when the history buffer can be predetermined. When the data is later uncompressed with Inflater.inflate(), Inflater.getAdler() can be called in order to get the Adler-32 value of the dictionary required for decompression.
Parameters: - b - the dictionary data bytes
- off - the start offset of the data
- len - the length of the data
See Also:Inflater.inflate(byte[], int, int),
Inflater.getAdler(),
public void
setInput
(byte[] b)
Sets input data for compression.
Sets input data for compression. This should be called whenever needsInput() returns true indicating that more input data is required.
Parameters: - b - the input data bytes
See Also:Deflater.needsInput(),
publicsynchronized void
setInput
(byte[] b, int off, int len)
Sets input data for compression.
Sets input data for compression. This should be called whenever needsInput() returns true indicating that more input data is required.
Parameters: - b - the input data bytes
- off - the start offset of the data
- len - the length of the data
See Also:Deflater.needsInput(),
publicsynchronized void
setLevel
(int level)
Sets the current compression level to the specified value.
Sets the current compression level to the specified value.
Parameters: - level - the new compression level (0-9)
Throws: - IllegalArgumentException - if the compression level is invalid
Sets the compression strategy to the specified value.
Sets the compression strategy to the specified value.
Parameters: - strategy - the new compression strategy
Throws: - IllegalArgumentException - if the compression strategy is
invalid
Compression method for the deflate algorithm (the only one currently
supported).
publicfinalstatic
int FILTERED
= "1"
Compression strategy best used for data consisting mostly of small
values with a somewhat random distribution.
Compression strategy best used for data consisting mostly of small values with a somewhat random distribution. Forces more Huffman coding and less string matching.