org.dice_research.ldcbench.utils.tar

Class TarFileGenerator

java.lang.Object

org.dice_research.ldcbench.utils.tar.TarFileGenerator

public class TarFileGenerator
extends Object

A simple generator for a tar file based on a given, sorted Map.

Author:

Michael Röder (michael.roeder@uni-paderborn.de)

Constructor Summary

Constructors

Constructor and Description
TarFileGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate(SortedMap<String,File> files, org.apache.commons.compress.archivers.tar.TarArchiveOutputStream outStream) The method writes the files from the given sorted Mapping to the given output stream.
void	generateTarFile(File file, SortedMap<String,File> files, boolean useGZ) The easiest way to generate a tar file with the given file name, the given list of files that will be added to the archive and a flag for creating a compressed archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

TarFileGenerator

public TarFileGenerator()

Method Detail

generateTarFile

public void generateTarFile(File file,
                            SortedMap<String,File> files,
                            boolean useGZ)
                     throws IOException

The easiest way to generate a tar file with the given file name, the given list of files that will be added to the archive and a flag for creating a compressed archive.

The given Map is a sorted mapping from file names (including directories) the files will have within the archive to real world files. For example, the given Map could contain the entries ("dir1/file0", "/home/file12"), ("dir1/file1", "/home/dir14/dir9/file99.txt"), ("README.md", "README.md"). The key of the entries will define how the archive itself will be structured. In the given example, there will be a "README.md" file as well as a directory "dir1" in the root directory of the archive. "dir1" will contain two file "file0" and "file1". The value of the entries defines where the content of the files is taken from. It can be seen that these files can be located in completely different locations.

Parameters:

file - the name and path of the tar file that will be written by this method

files - the mapping of internal file names to file paths used to read the files

useGZ - if this flag is true, the tar file will be compressed using gzip.

Throws:

IOException - is thrown if either the tar file can not be written or one of the files in the given map can not be read.

generate

public void generate(SortedMap<String,File> files,
                     org.apache.commons.compress.archivers.tar.TarArchiveOutputStream outStream)
              throws IOException

The method writes the files from the given sorted Mapping to the given output stream.

The given Map is a sorted mapping from file names (including directories) the files will have within the archive to real world files. For example, the given Map could contain the entries ("dir1/file0", "/home/file12"), ("dir1/file1", "/home/dir14/dir9/file99.txt"), ("README.md", "README.md"). The key of the entries will define how the archive itself will be structured. In the given example, there will be a "README.md" file as well as a directory "dir1" in the root directory of the archive. "dir1" will contain two file "file0" and "file1". The value of the entries defines where the content of the files is taken from. It can be seen that these files can be located in completely different locations.

Parameters:

files - the mapping of internal file names to file paths used to read the files

outStream - the output stream to which the files will be written.

Throws:

IOException - is thrown if either the tar file can not be written or one of the files in the given map can not be read.