ikr.simlib.support.compression

Class CompressionManager

java.lang.Object

ikr.simlib.support.compression.CompressionManager

public class CompressionManager
extends java.lang.Object

This class provides static methods to

• open compressed files for reading
• create and open compressed files for writing
• determining the filename suffix for a given compression type

To avoid direct dependencies to compression libraries, the ServiceLoader concept is used. This allows additional compression types to be added without changing any SimLib class. The SimLib supports uncompressed files as well as the compressed files of the types gzip, xz, lzma and bzip2.

To implement additional compression types, you have to

• create a class which implements CompressionProvider
• add the provider description to the jar file which contains your class (see ServiceLoader and http://ant.apache.org/manual/Tasks/jar.html
• place the jar with your class and the provider description in the classpath of the simulation

Constructor Summary

Constructors

Constructor and Description
CompressionManager()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getFilenameWithExtension(java.lang.String fileName, CompressionType compressionType)
static java.io.InputStream	getInputStream(java.io.File file) Opens the given file for reading.
static java.io.OutputStream	getOutPutStream(java.io.File file) Opens the given file for writing.
static java.io.OutputStream	getOutputStream(java.io.File file, CompressionType compressionType) Opens the given file for writing.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressionManager

public CompressionManager()

Method Detail

getInputStream

public static java.io.InputStream getInputStream(java.io.File file)
                                          throws java.io.FileNotFoundException

Opens the given file for reading.

Parameters:

file - the file to open, with extension as it is on the disk

Returns:

an InputStream to read the file

Throws:

java.io.FileNotFoundException - when the file is not readable

getOutputStream

public static java.io.OutputStream getOutputStream(java.io.File file,
                                   CompressionType compressionType)
                                            throws java.io.FileNotFoundException

Opens the given file for writing. The extension is not appended automatically. See getFilenameWithExtension(String, CompressionType).

Parameters:

file - the file to open, with extension as it shall be created

compressionType - the type of file compression which shall be used

Returns:

an OutputStream to write to this file

Throws:

java.io.FileNotFoundException - when the file cannot be created

getOutPutStream

public static java.io.OutputStream getOutPutStream(java.io.File file)
                                            throws java.io.FileNotFoundException

Opens the given file for writing. The file type will be determined by the extension which has to be included in fileWithExt. If the file extension is specified within CompressionType then a file with corresponding compression shall be created. If the extension could not be recognized then a regular file of given name and extension shall be created.

Parameters:

file - the file to open, with extension as it shall be created

Returns:

an OutputStream to write to this file

Throws:

java.io.FileNotFoundException - when the file cannot be created

getFilenameWithExtension

public static java.lang.String getFilenameWithExtension(java.lang.String fileName,
                                        CompressionType compressionType)