FileDocCategorySizeDatePackage
Deflater.javaAPI DocJava SE 6 API12572Tue Jun 10 00:26:00 BST 2008java.util.zip

Deflater

public class Deflater extends Object
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\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
}
see
Inflater
version
1.45, 04/07/06
author
David Connelly

Fields Summary
private long
strm
private byte[]
buf
private int
off
private int
len
private int
level
private int
strategy
private boolean
setParams
private boolean
finish
private boolean
finished
public static final int
DEFLATED
Compression method for the deflate algorithm (the only one currently supported).
public static final int
NO_COMPRESSION
Compression level for no compression.
public static final int
BEST_SPEED
Compression level for fastest compression.
public static final int
BEST_COMPRESSION
Compression level for best compression.
public static final int
DEFAULT_COMPRESSION
Default compression level.
public static final int
FILTERED
Compression strategy best used for data consisting mostly of small values with a somewhat random distribution. Forces more Huffman coding and less string matching.
public static final int
HUFFMAN_ONLY
Compression strategy for Huffman coding only.
public static final int
DEFAULT_STRATEGY
Default compression strategy.
Constructors Summary
public Deflater(int level, boolean nowrap)
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.

param
level the compression level (0-9)
param
nowrap if true then use GZIP compatible compression


     
	/* Zip library is loaded from System.initializeSystemClass */
	initIDs();
    
	this.level = level;
	this.strategy = DEFAULT_STRATEGY;
	strm = init(level, DEFAULT_STRATEGY, nowrap);
    
public Deflater(int level)
Creates a new compressor using the specified compression level. Compressed data will be generated in ZLIB format.

param
level the compression level (0-9)

	this(level, false);
    
public Deflater()
Creates a new compressor with the default compression level. Compressed data will be generated in ZLIB format.

	this(DEFAULT_COMPRESSION, false);
    
Methods Summary
public synchronized intdeflate(byte[] b, int off, int len)
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.

param
b the buffer for the compressed data
param
off the start offset of the data
param
len the maximum number of bytes of compressed data
return
the actual number of bytes of compressed data

	if (b == null) {
	    throw new NullPointerException();
	}
        if (off < 0 || len < 0 || off > b.length - len) {
	    throw new ArrayIndexOutOfBoundsException();
	}
	return deflateBytes(b, off, len);
    
public intdeflate(byte[] b)
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.

param
b the buffer for the compressed data
return
the actual number of bytes of compressed data

	return deflate(b, 0, b.length);
    
private native intdeflateBytes(byte[] b, int off, int len)

public synchronized voidend()
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.

	if (strm != 0) {
	    end(strm);
	    strm = 0;
	    buf = null;
	}
    
private static native voidend(long strm)

private voidensureOpen()

	if (strm == 0)
	    throw new NullPointerException();
    
protected voidfinalize()
Closes the compressor when garbage is collected.

	end();
    
public synchronized voidfinish()
When called, indicates that compression should end with the current contents of the input buffer.

	finish = true;
    
public synchronized booleanfinished()
Returns true if the end of the compressed data output stream has been reached.

return
true if the end of the compressed data output stream has been reached

	return finished;
    
public synchronized intgetAdler()
Returns the ADLER-32 value of the uncompressed data.

return
the ADLER-32 value of the uncompressed data

	ensureOpen();
	return getAdler(strm);
    
private static native intgetAdler(long strm)

public synchronized longgetBytesRead()
Returns the total number of uncompressed bytes input so far.

return
the total (non-negative) number of uncompressed bytes input so far
since
1.5

	ensureOpen();
	return getBytesRead(strm);
    
private static native longgetBytesRead(long strm)

public synchronized longgetBytesWritten()
Returns the total number of compressed bytes output so far.

return
the total (non-negative) number of compressed bytes output so far
since
1.5

	ensureOpen();
	return getBytesWritten(strm);
    
private static native longgetBytesWritten(long strm)

public intgetTotalIn()
Returns the total number of uncompressed bytes input so far.

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

return
the total number of uncompressed bytes input so far

	return (int) getBytesRead();
    
public intgetTotalOut()
Returns the total number of compressed bytes output so far.

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

return
the total number of compressed bytes output so far

	return (int) getBytesWritten();
    
private static native longinit(int level, int strategy, boolean nowrap)

private static native voidinitIDs()

public booleanneedsInput()
Returns true if the input data buffer is empty and setInput() should be called in order to provide more input.

return
true if the input data buffer is empty and setInput() should be called in order to provide more input

	return len <= 0;
    
public synchronized voidreset()
Resets deflater so that a new set of input data can be processed. Keeps current compression level and strategy settings.

	ensureOpen();
	reset(strm);
	finish = false;
	finished = false;
	off = len = 0;
    
private static native voidreset(long strm)

private static native voidsetDictionary(long strm, byte[] b, int off, int len)

public synchronized voidsetDictionary(byte[] b, int off, int len)
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.

param
b the dictionary data bytes
param
off the start offset of the data
param
len the length of the data
see
Inflater#inflate
see
Inflater#getAdler

	if (strm == 0 || b == null) {
	    throw new NullPointerException();
	}
        if (off < 0 || len < 0 || off > b.length - len) {
	    throw new ArrayIndexOutOfBoundsException();
	}
	setDictionary(strm, b, off, len);
    
public voidsetDictionary(byte[] b)
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.

param
b the dictionary data bytes
see
Inflater#inflate
see
Inflater#getAdler

	setDictionary(b, 0, b.length);
    
public synchronized voidsetInput(byte[] b, int off, int len)
Sets input data for compression. This should be called whenever needsInput() returns true indicating that more input data is required.

param
b the input data bytes
param
off the start offset of the data
param
len the length of the data
see
Deflater#needsInput

	if (b== null) {
	    throw new NullPointerException();
	}
        if (off < 0 || len < 0 || off > b.length - len) {
	    throw new ArrayIndexOutOfBoundsException();
	}
	this.buf = b;
	this.off = off;
	this.len = len;
    
public voidsetInput(byte[] b)
Sets input data for compression. This should be called whenever needsInput() returns true indicating that more input data is required.

param
b the input data bytes
see
Deflater#needsInput

	setInput(b, 0, b.length);
    
public synchronized voidsetLevel(int level)
Sets the current compression level to the specified value.

param
level the new compression level (0-9)
exception
IllegalArgumentException if the compression level is invalid

	if ((level < 0 || level > 9) && level != DEFAULT_COMPRESSION) {
	    throw new IllegalArgumentException("invalid compression level");
	}
	if (this.level != level) {
	    this.level = level;
	    setParams = true;
	}
    
public synchronized voidsetStrategy(int strategy)
Sets the compression strategy to the specified value.

param
strategy the new compression strategy
exception
IllegalArgumentException if the compression strategy is invalid

	switch (strategy) {
	  case DEFAULT_STRATEGY:
	  case FILTERED:
	  case HUFFMAN_ONLY:
	    break;
	  default:
	    throw new IllegalArgumentException();
	}
	if (this.strategy != strategy) {
	    this.strategy = strategy;
	    setParams = true;
	}