org.pfsw.file

Class ZipFileCreator

java.lang.Object

org.pfsw.file.ZipFileCreator

public class ZipFileCreator
extends java.lang.Object

Simplifies creation of Zip files.

Constructor Summary

Constructors

Constructor and Description
ZipFileCreator()

Method Summary

Modifier and Type	Method and Description
static ZipFileCreator	create()
boolean	preserveBaseFolder() Returns true if all files should be put under the base folder name in the zip file.
ZipFileCreator	setPreserveBaseFolder(boolean preserveBaseFolder) Sets whether or not all files should be put under the base folder name in the zip file.
long	zipAllInto(java.lang.String startFolder, java.io.File zipFile) Create (or overwrite) the zip file and put all file under the specified start folder and its sub-folders into it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileCreator

public ZipFileCreator()

Method Detail

create

public static ZipFileCreator create()

zipAllInto

public long zipAllInto(java.lang.String startFolder,
                       java.io.File zipFile)

Create (or overwrite) the zip file and put all file under the specified start folder and its sub-folders into it.

Parameters:

startFolder - The folder from where to start recursive file processing (must not be null).

zipFile - The target zip file (must not be null).

Returns:

The number of processed (zipped) files.

Throws:

IORuntimeException - in any case of error.

preserveBaseFolder

public boolean preserveBaseFolder()

Returns true if all files should be put under the base folder name in the zip file. The default value is false.

setPreserveBaseFolder

public ZipFileCreator setPreserveBaseFolder(boolean preserveBaseFolder)

Sets whether or not all files should be put under the base folder name in the zip file. The default value is false.