org.ops4j.pax.exam.spi.war

Class ZipBuilder

java.lang.Object

org.ops4j.pax.exam.spi.war.ZipBuilder

public class ZipBuilder
extends Object

Builds a ZIP archive from individual files and directories.

Author:

Harald Wellmann

Constructor Summary

Constructors

Constructor and Description
ZipBuilder(File zipFile) Creates a ZIP archive in the given file.

Method Summary

Modifier and Type	Method and Description
ZipBuilder	addDirectory(File sourceDir, String targetDir) Recursively adds a directory tree to the archive.
ZipBuilder	addFile(File sourceFile, String targetFile) Adds a file to the archive.
void	close() Closes the archive and releases file system resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipBuilder

public ZipBuilder(File zipFile)
           throws IOException

Creates a ZIP archive in the given file. Allocates underlying file system resources. The user must call close() to release these resources.

Parameters:

zipFile - archive file to be created

Throws:

IOException - on I/O error

Method Detail

addDirectory

public ZipBuilder addDirectory(File sourceDir,
                               String targetDir)
                        throws IOException

Recursively adds a directory tree to the archive. The archive must not be closed.

Example:

 sourceDir = /opt/work/classes
 targetDir = WEB-INF/classes

 /opt/work/classes/com/acme/Foo.class -> WEB-INF/classes/com/acme/Foo.class
 

Parameters:

sourceDir - Root directory of tree to be added

targetDir - Relative path within the archive corresponding to root. Regardless of the OS, this path must use slashes ('/') as separators.

Returns:

this for fluent syntax

Throws:

IOException - on I/O error

addFile

public ZipBuilder addFile(File sourceFile,
                          String targetFile)
                   throws IOException

Adds a file to the archive. The archive must not be closed.

Example:

 sourceFile = C:\opt\work\deps\foo.jar
 targetDir = WEB-INF/lib/foo.jar

 

Parameters:

sourceFile - File to be added

targetFile - Relative path for the file within the archive. Regardless of the OS, this path must use slashes ('/') as separators.

Returns:

this for fluent syntax

Throws:

IOException - on I/O error

close

public void close()
           throws IOException

Closes the archive and releases file system resources. No more files or directories may be added after calling this method.

Throws:

IOException - on I/O error