org.xmlactions.common.zip

Class ZipFileWriter

java.lang.Object

org.xmlactions.common.zip.ZipFileWriter

public class ZipFileWriter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ZipFileWriter(java.lang.String fileName)

Method Summary

Modifier and Type	Method and Description
void	addFile(java.io.InputStream in, java.lang.String entryName)
void	addFile(java.io.InputStream in, java.lang.String entryName, java.lang.String comment)
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	closeFile() Close the zip file entry opened from startFile(...)
void	closeZip() Close the zip file.
void	createFolder(java.lang.String entryName, long time, java.lang.String comment) Creates a folder in the zip file
java.util.zip.ZipOutputStream	getZipOutputStream()
void	setComment(java.lang.String comment) Sets a comment to the zipOutputStream.
void	startFile(java.lang.String entryName, long time) Opens a zip file entry ready for writing
void	write(byte[] buf, int size) Write the buf data to the zip file entry opened from startFile(...)
void	write(java.io.InputStream in) Write data from the InputStream to the zip file entry opened from startFile(...)

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileWriter

public ZipFileWriter(java.lang.String fileName)
              throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

Method Detail

setComment

public void setComment(java.lang.String comment)

Sets a comment to the zipOutputStream. Not sure what use this is as we cant get it back. TODO how to read back the comment

Parameters:

comment -

closeZip

public void closeZip()
              throws java.io.IOException

Close the zip file. Once this is called we cant add any more files.

Throws:

java.io.IOException

getZipOutputStream

public java.util.zip.ZipOutputStream getZipOutputStream()

addFile

public void addFile(java.lang.String pathAndFileName,
                    java.lang.String entryName)
             throws java.io.FileNotFoundException,
                    java.io.IOException

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.io.FileNotFoundException

java.io.IOException

addFile

public void addFile(java.lang.String pathAndFileName,
                    java.lang.String entryName,
                    java.lang.String comment)
             throws java.io.FileNotFoundException,
                    java.io.IOException

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.io.FileNotFoundException

java.io.IOException

addFile

public void addFile(java.io.InputStream in,
                    java.lang.String entryName)
             throws java.io.IOException

Parameters:

in - - is an InputStream created from the ZipEntry

entryName - - is the full path and file name

Throws:

java.io.IOException

addFile

public void addFile(java.io.InputStream in,
                    java.lang.String entryName,
                    java.lang.String comment)
             throws java.io.IOException

Parameters:

in - - is an InputStream created from the ZipEntry

entryName - - is the full path and file name

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

Throws:

java.io.IOException

createFolder

public void createFolder(java.lang.String entryName,
                         long time,
                         java.lang.String comment)
                  throws java.io.IOException

Creates a folder in the zip file

Parameters:

entryName - is the full path and file name

time - is the source creation time

comment - if not null will be added to the folder.

Throws:

java.io.IOException

startFile

public void startFile(java.lang.String entryName,
                      long time)
               throws java.io.IOException

Opens a zip file entry ready for writing

Parameters:

entryName - is the full path and file name

Throws:

java.io.IOException

write

public void write(java.io.InputStream in)
           throws java.io.IOException

Write data from the InputStream to the zip file entry opened from startFile(...)

Parameters:

in - is an InputStream created from the ZipEntry

Throws:

java.io.IOException

write

public void write(byte[] buf,
                  int size)
           throws java.io.IOException

Write the buf data to the zip file entry opened from startFile(...)

Parameters:

buf - is the data to write

size - is the size of the buf

Throws:

java.io.IOException

closeFile

public void closeFile()
               throws java.io.IOException

Close the zip file entry opened from startFile(...)

Throws:

java.io.IOException