org.xmlactions.common.zip

Class ZipFile

java.lang.Object

org.xmlactions.common.zip.ZipFile

public class ZipFile
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ZipFile(java.lang.String sourceZipFileName) Creates a new instance of ZipFile
ZipFile(java.lang.String sourceZipFileName, boolean createNewFile) Open a new or existing zip file.

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String pathAndFileName, java.lang.String entryName)
void	addFile(java.lang.String pathAndFileName, java.lang.String entryName, java.lang.String comment)
void	closeZip() Must call this when zipping is completed.
static void	copyFiles(ZipFileReader zr, ZipFileWriter zw)
void	openZip(java.lang.String sourceZipFileName, boolean createNewFile) Open a new or existing zip file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFile

public ZipFile(java.lang.String sourceZipFileName)
        throws java.lang.Exception

Creates a new instance of ZipFile

Throws:

java.lang.Exception

ZipFile

public ZipFile(java.lang.String sourceZipFileName,
               boolean createNewFile)
        throws java.lang.Exception

Open a new or existing zip file. If source zip file exists then we first need to copy all the files in this zip file to a new zip file (which we rename at the end). Will leave the new zip file open for addition of other files, you must call ZipFile.close() to close the zip file, which will rename the zip file if necessary.

Parameters:

sourceZipFileName - is the name of a new or existing zip file.

createNewFile - if set true will overwrite any existing file

Throws:

java.lang.Exception - on detection of an error

Method Detail

openZip

public void openZip(java.lang.String sourceZipFileName,
                    boolean createNewFile)
             throws java.lang.Exception

Open a new or existing zip file. If source zip file exists then we first need to copy all the files in this zip file to a new zip file (which we rename at the end). Will leave the new zip file open for addition of other files, you must call ZipFile.close() to close the zip file, which will rename the zip file if necessary.

Parameters:

sourceZipFileName - is the name of a new or existing zip file.

createNewFile - if set true will overwrite any existing file

Throws:

java.lang.Exception - on detection of an error

addFile

public void addFile(java.lang.String pathAndFileName,
                    java.lang.String entryName)
             throws java.lang.Exception

Parameters:

pathAndFileName - is the location of the file to insert into the zip file

entryName - is an optional name that will be used instead of the pathAndFileName if it's not null

Throws:

java.lang.Exception

addFile

public void addFile(java.lang.String pathAndFileName,
                    java.lang.String entryName,
                    java.lang.String comment)
             throws java.lang.Exception

Parameters:

pathAndFileName - is the location of the file to insert into the zip file

entryName - is an optional name that will be used instead of the pathAndFileName if it's not null

comment - - will be added to the ZipEntry if not null

Throws:

java.lang.Exception

closeZip

public void closeZip()
              throws java.lang.Exception

Must call this when zipping is completed.

Throws:

java.lang.Exception

copyFiles

public static void copyFiles(ZipFileReader zr,
                             ZipFileWriter zw)
                      throws java.io.IOException

Throws:

java.io.IOException