Module kala.compress.compressors.deflate

Package kala.compress.compressors.deflate

Class DeflateParameters

java.lang.Object

kala.compress.compressors.deflate.DeflateParameters

public class DeflateParameters
extends java.lang.Object

Parameters for the Deflate compressor.

Since:

1.9

Field Summary

Fields

Modifier and Type	Field	Description
private int	compressionLevel
(package private) static int	MAX_LEVEL
(package private) static int	MIN_LEVEL
private boolean	zlibHeader

Constructor Summary

Constructors

Constructor	Description
DeflateParameters()

Method Summary

Modifier and Type	Method	Description
int	getCompressionLevel()	The compression level.
void	setCompressionLevel(int compressionLevel)	Sets the compression level.
void	setWithZlibHeader(boolean zlibHeader)	Sets the zlib header presence parameter.
boolean	withZlibHeader()	Whether or not the zlib header shall be written (when compressing) or expected (when decompressing).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_LEVEL

static final int MAX_LEVEL

See Also:

Constant Field Values

MIN_LEVEL

static final int MIN_LEVEL

See Also:

Constant Field Values

zlibHeader

private boolean zlibHeader

compressionLevel

private int compressionLevel

Constructor Detail

DeflateParameters

public DeflateParameters()

Method Detail

getCompressionLevel

public int getCompressionLevel()

The compression level.

Returns:

the compression level

See Also:

setCompressionLevel(int)

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Sets the compression level.

Parameters:

compressionLevel - the compression level (between 0 and 9)

See Also:

Deflater.NO_COMPRESSION, Deflater.BEST_SPEED, Deflater.DEFAULT_COMPRESSION, Deflater.BEST_COMPRESSION

setWithZlibHeader

public void setWithZlibHeader(boolean zlibHeader)

Sets the zlib header presence parameter.

This affects whether or not the zlib header will be written (when compressing) or expected (when decompressing).

Parameters:

zlibHeader - true if zlib header shall be written

withZlibHeader

public boolean withZlibHeader()

Whether or not the zlib header shall be written (when compressing) or expected (when decompressing).

Returns:

true if zlib header shall be written