de.innovationgate.utils

Class DirZipper

java.lang.Object

de.innovationgate.utils.DirZipper

public class DirZipper
extends java.lang.Object

Tool to zip the contents of a directory to a ZIP file, using the java ZIP functionalities

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DirZipper.DefaultInputStreamProvider Default implementation of InputStreamProvider that just returns plain FileInputStream-Objects for files
static interface	DirZipper.InputStreamProvider A provider of input streams for individual files in the directory to zip up.

Constructor Summary

Constructors

Constructor and Description
DirZipper()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilePatternToIgnore(java.lang.String name) Adds a file name pattern as regular expression that should be ignored when zipping the directory.
DirZipper.InputStreamProvider	getInputStreamProvider() Returns the input stream provider that the DirZipper will use to fetch input streams for indidivual files
void	setInputStreamProvider(DirZipper.InputStreamProvider inputStreamProvider) Sets the input stream provider that the DirZipper will use to fetch input streams for indidivual files
void	unzipDirectory(java.io.File targetDir, java.util.zip.ZipInputStream zis) Unzips the content of the given input stream to a directory
void	zipDirectory(java.io.File zipDir, java.util.zip.ZipOutputStream zos) Zips a directory to a zip output stream.
void	zipDirectory(java.io.File zipDir, java.util.zip.ZipOutputStream zos, java.lang.String qualifier) Zips the contents of a local directory to a ZIP archive
void	zipFile(java.io.File file, java.util.zip.ZipOutputStream zos) Zips a file or directory to the output stream
void	zipNormalFile(java.io.File f, java.util.zip.ZipOutputStream zos, java.lang.String qualifier) Zips a single normal file (no directory!)

Methods inherited from class java.lang.Object

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

Constructor Detail

DirZipper

public DirZipper()

Method Detail

zipDirectory

public void zipDirectory(java.io.File zipDir,
                java.util.zip.ZipOutputStream zos)
                  throws java.io.IOException

Zips a directory to a zip output stream.

Parameters:

zipDir - The directory whose contents will be in the zip file

zos - The zip output stream adressing the correct target for zipped data

Throws:

java.io.IOException

zipFile

public void zipFile(java.io.File file,
           java.util.zip.ZipOutputStream zos)
             throws java.io.IOException

Zips a file or directory to the output stream

Parameters:

file - The file to zip. In case of a directory all the contents will be zipped

zos - The ZIP output stream

Throws:

java.io.IOException

unzipDirectory

public void unzipDirectory(java.io.File targetDir,
                  java.util.zip.ZipInputStream zis)
                    throws java.io.IOException

Unzips the content of the given input stream to a directory

Parameters:

targetDir - The directory where to unzip the data to

zis - The input stream

Throws:

java.io.IOException - if something goes horribly wrong

zipDirectory

public void zipDirectory(java.io.File zipDir,
                java.util.zip.ZipOutputStream zos,
                java.lang.String qualifier)
                  throws java.io.IOException

Zips the contents of a local directory to a ZIP archive

Parameters:

zipDir - The directory to zip, including all contained files

zos - The zip output stream

qualifier - Some qualifier identifying the directory inside the zip to which the file should be put. Specify an empty string to make it a root file. Specify some dir path ending with "/" to put it to a directory.

Throws:

java.io.IOException

zipNormalFile

public void zipNormalFile(java.io.File f,
                 java.util.zip.ZipOutputStream zos,
                 java.lang.String qualifier)
                   throws java.io.FileNotFoundException,
                          java.io.IOException

Zips a single normal file (no directory!) to the zip output stream.

Parameters:

f - The file

zos - The zip output stream

qualifier - Some qualifier identifying the directory inside the zip to which the file should be put. Specify an empty string to make it a root file. Specify some dir path ending with "/" to put it to a directory.

Throws:

java.io.FileNotFoundException

java.io.IOException

getInputStreamProvider

public DirZipper.InputStreamProvider getInputStreamProvider()

Returns the input stream provider that the DirZipper will use to fetch input streams for indidivual files

setInputStreamProvider

public void setInputStreamProvider(DirZipper.InputStreamProvider inputStreamProvider)

Sets the input stream provider that the DirZipper will use to fetch input streams for indidivual files

Parameters:

inputStreamProvider - The provider to use

addFilePatternToIgnore

public void addFilePatternToIgnore(java.lang.String name)

Adds a file name pattern as regular expression that should be ignored when zipping the directory. Files/Directories of that name will be omitted

Parameters:

name - The pattern to ignore