Package adams.core.io

Class LzfUtils

java.lang.Object

adams.core.io.LzfUtils

public class LzfUtils
extends Object

Helper class for LZF related operations.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXTENSION	the default extension.
protected static Logger	LOGGER	for logging errors.

Constructor Summary

Constructors

Constructor	Description
LzfUtils()

Method Summary

Modifier and Type	Method	Description
static byte[]	compress(byte[] input)	Compresses the specified bytes using lzf.
static byte[]	compress(byte[] input, MessageCollection errors)	Compresses the specified bytes using lzf.
static String	compress(File inputFile, int buffer)	Compresses the specified lzma archive to a file with the ".lzf" extension.
static String	compress(File inputFile, int buffer, File outputFile)	Compresses the specified lzma archive.
static String	compress(File inputFile, int buffer, File outputFile, boolean removeInput)	Compresses the specified lzma archive.
static byte[]	decompress(byte[] input, int buffer)	Decompresses the specified lzf compressed bytes.
static byte[]	decompress(byte[] input, int buffer, MessageCollection errors)	Decompresses the specified lzf compressed bytes.
static String	decompress(File archiveFile, int buffer)	Decompresses the specified lzma archive to a file without the ".lzf" extension.
static String	decompress(File archiveFile, int buffer, File outputFile)	Decompresses the specified lzma archive.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION

public static final String EXTENSION

the default extension.

See Also:

Constant Field Values

LOGGER

protected static Logger LOGGER

for logging errors.

Constructor Detail

LzfUtils

public LzfUtils()

Method Detail

decompress

public static String decompress(File archiveFile,
                                int buffer)

Decompresses the specified lzma archive to a file without the ".lzf" extension.

Parameters:

archiveFile - the gzip file to decompress

buffer - the buffer size to use

Returns:

the error message, null if everything OK

decompress

public static String decompress(File archiveFile,
                                int buffer,
                                File outputFile)

Decompresses the specified lzma archive.

Parameters:

archiveFile - the lzma file to decompress

buffer - the buffer size to use

outputFile - the destination file

Returns:

the error message, null if everything OK

compress

public static String compress(File inputFile,
                              int buffer)

Compresses the specified lzma archive to a file with the ".lzf" extension.

Parameters:

inputFile - the file to compress

buffer - the buffer size to use

Returns:

the error message, null if everything OK

compress

public static String compress(File inputFile,
                              int buffer,
                              File outputFile)

Compresses the specified lzma archive. Does not remove the input file.

Parameters:

inputFile - the file to compress

buffer - the buffer size to use

outputFile - the destination file (the archive)

Returns:

the error message, null if everything OK

compress

public static String compress(File inputFile,
                              int buffer,
                              File outputFile,
                              boolean removeInput)

Compresses the specified lzma archive.

Parameters:

inputFile - the file to compress

buffer - the buffer size to use

outputFile - the destination file (the archive)

removeInput - whether to remove the input file

Returns:

the error message, null if everything OK

compress

public static byte[] compress(byte[] input)

Compresses the specified bytes using lzf.

Parameters:

input - the bytes to compress

Returns:

the compressed bytes, null in case of error

compress

public static byte[] compress(byte[] input,
                              MessageCollection errors)

Compresses the specified bytes using lzf.

Parameters:

input - the bytes to compress

Returns:

the compressed bytes, null in case of error

decompress

public static byte[] decompress(byte[] input,
                                int buffer)

Decompresses the specified lzf compressed bytes.

Parameters:

input - the compressed bytes

buffer - the buffer size to use

Returns:

the decompressed bytes, null in case of error

decompress

public static byte[] decompress(byte[] input,
                                int buffer,
                                MessageCollection errors)

Decompresses the specified lzf compressed bytes.

Parameters:

input - the compressed bytes

buffer - the buffer size to use

errors - for collecting errors

Returns:

the decompressed bytes, null in case of error