com.j256.simplezip

Class ZipFileOutput

java.lang.Object

com.j256.simplezip.ZipFileOutput

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZipFileOutput
extends Object
implements Closeable

Write out a Zip-file to either a File or an OutputStream.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ZipFileOutput.ZipFileDataOutputStream Output stream that can be used to write data for a single zip file.

Constructor Summary

Constructors

Constructor and Description
ZipFileOutput(File file) Start writing a Zip-file to a file.
ZipFileOutput(OutputStream outputStream) Start writing a Zip-file to an output-stream.
ZipFileOutput(String filePath) Start writing a Zip-file to a file-path.

Method Summary

Modifier and Type	Method and Description
boolean	addDirectoryFileInfo(String fileName, ZipCentralDirectoryFileInfo fileInfo) Add additional information (most optional_ to the Zip central-directory file-header to be associated with the file-name parameter This information is written to the end of the Zip-file and which holds information about the files that is not contained in the ZipFileHeader.
void	addDirectoryFileInfo(ZipCentralDirectoryFileInfo fileInfo) Add additional information (most optional) to the Zip central-directory file-header to be associated with the most recent file-header.
void	close() Close the associated output stream.
void	enableFileBuffering(int maxSizeBuffered, int maxSizeInMemory) Attaches a buffered output stream to record the file-data _before_ writing out the file-header.
long	finishFileData() Called at the end of the file data.
long	finishZip() Finish writing the zip-file.
long	finishZip(ZipCentralDirectoryEndInfo endInfo) Finish writing the Zip-file with a comment.
void	flush() Flush the associated output stream.
long	getNumBytesWritten() Return the current number of bytes written to the output zip-file stream.
OutputStream	openFileDataOutputStream(boolean raw) Get an output stream suitable for writing the bytes for a single Zip file-entry.
long	writeFileData(File file) Write the contents of a file to the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
long	writeFileData(InputStream inputStream) Read from the input-stream and write its contents to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
long	writeFileData(String filePath) Write the contents of a file to the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
long	writeFileDataAll(byte[] buffer) Write the complete file data as single byte array to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
void	writeFileDataPart(byte[] buffer) Write file data as single or multiple byte arrays to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
void	writeFileDataPart(byte[] buffer, int offset, int length) Write file data as single or multiple byte arrays to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod().
void	writeFileHeader(ZipFileHeader fileHeader) Write a file-header which starts the Zip-file.
long	writeRawFileData(File file) Write the contents of a file to the Zip-file stream without any encoding.
long	writeRawFileData(InputStream inputStream) Read from the input-stream and write its contents to the the Zip-file stream without any encoding.
long	writeRawFileData(String filePath) Write the contents of a file to the Zip-file stream without any encoding.
void	writeRawFileDataPart(byte[] buffer) Write file data as single or multiple byte arrays to the the Zip-file stream without any encoding.
void	writeRawFileDataPart(byte[] buffer, int offset, int length) Write file data as single or multiple byte arrays to the the Zip-file stream without any encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileOutput

public ZipFileOutput(String filePath)
              throws FileNotFoundException

Start writing a Zip-file to a file-path. You must call close() to close the stream when you are done.

Throws:

FileNotFoundException

ZipFileOutput

public ZipFileOutput(File file)
              throws FileNotFoundException

Start writing a Zip-file to a file. You must call close() to close the stream when you are done.

Throws:

FileNotFoundException

ZipFileOutput

public ZipFileOutput(OutputStream outputStream)

Start writing a Zip-file to an output-stream. You must call close() to close the stream when you are done.

Method Detail

enableFileBuffering

public void enableFileBuffering(int maxSizeBuffered,
                                int maxSizeInMemory)

Attaches a buffered output stream to record the file-data _before_ writing out the file-header. This is useful because it means that the ZipFileHeader written before the file-data will contain the encoded size and the crc32 information as opposed to the ZipDataDescriptor which is written _after_ the file-data.

Parameters:

maxSizeBuffered - Maximum number of bytes that will be stored by the buffer before it gives up and will write out the header and the a ZipDataDescriptor after the file-data.

maxSizeInMemory - Maximum number of bytes that will be stored by in memory. If there is any space above this number but below the maxSizeBuffered then it will be written to a temporary file.

writeFileHeader

public void writeFileHeader(ZipFileHeader fileHeader)

Write a file-header which starts the Zip-file. This actually may or may not actually write it to disk depending on buffering.

addDirectoryFileInfo

public void addDirectoryFileInfo(ZipCentralDirectoryFileInfo fileInfo)

Add additional information (most optional) to the Zip central-directory file-header to be associated with the most recent file-header. This information is written to the end of the Zip-file and which holds information about the files that is not contained in the ZipFileHeader.

addDirectoryFileInfo

public boolean addDirectoryFileInfo(String fileName,
                                    ZipCentralDirectoryFileInfo fileInfo)

Add additional information (most optional_ to the Zip central-directory file-header to be associated with the file-name parameter This information is written to the end of the Zip-file and which holds information about the files that is not contained in the ZipFileHeader.

Returns:

True if this works otherwise false if the file-name is not found.

writeFileData

public long writeFileData(String filePath)
                   throws IOException

Write the contents of a file to the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeRawFileData

public long writeRawFileData(String filePath)
                      throws IOException

Write the contents of a file to the Zip-file stream without any encoding. Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeFileData

public long writeFileData(File file)
                   throws IOException

Write the contents of a file to the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeRawFileData

public long writeRawFileData(File file)
                      throws IOException

Write the contents of a file to the Zip-file stream without any encoding. Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeFileData

public long writeFileData(InputStream inputStream)
                   throws IOException

Read from the input-stream and write its contents to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeRawFileData

public long writeRawFileData(InputStream inputStream)
                      throws IOException

Read from the input-stream and write its contents to the the Zip-file stream without any encoding. Must be called after you write the file-header. NOTE: this method calls finishFileData() for you.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

openFileDataOutputStream

public OutputStream openFileDataOutputStream(boolean raw)

Get an output stream suitable for writing the bytes for a single Zip file-entry. A call to the OutputStream.write(byte[], int, int) basically calls through to writeFileDataPart(byte[], int, int). A call to OutputStream.close() calls through to finishFileData().

Parameters:

raw - Set to true to have write() call thru to writeRawFileDataPart(byte[], int, int) or false to have it call thru tol writeFileDataPart(byte[], int, int).

writeFileDataAll

public long writeFileDataAll(byte[] buffer)
                      throws IOException

Write the complete file data as single byte array to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. This method calls finishFileData() after the write.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

writeFileDataPart

public void writeFileDataPart(byte[] buffer)
                       throws IOException

Write file data as single or multiple byte arrays to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. At the end of the writing, you must call finishFileData().

Throws:

IOException

writeRawFileDataPart

public void writeRawFileDataPart(byte[] buffer)
                          throws IOException

Write file data as single or multiple byte arrays to the the Zip-file stream without any encoding. Must be called after you write the file-header. At the end of the writing, you must call finishFileData().

Throws:

IOException

writeFileDataPart

public void writeFileDataPart(byte[] buffer,
                              int offset,
                              int length)
                       throws IOException

Write file data as single or multiple byte arrays to the the Zip-file stream while encoding it based on the ZipFileHeader.getCompressionMethod(). Must be called after you write the file-header. At the end of the writing, you must call finishFileData().

Throws:

IOException

writeRawFileDataPart

public void writeRawFileDataPart(byte[] buffer,
                                 int offset,
                                 int length)
                          throws IOException

Write file data as single or multiple byte arrays to the the Zip-file stream without any encoding. Must be called after you write the file-header. At the end of the writing, you must call finishFileData().

Throws:

IOException

finishFileData

public long finishFileData()
                    throws IOException

Called at the end of the file data. Must be called after the writeFileDataPart(byte[]) or writeFileDataPart(byte[], int, int) methods have been called. NOTE: This will write a ZipDataDescriptor at the end of the file unless a CRC32, compressed, or uncompressed size was specified in the header.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

finishZip

public long finishZip()
               throws IOException

Finish writing the zip-file. See the finishZip(ZipCentralDirectoryEndInfo) for more information.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

finishZip

public long finishZip(ZipCentralDirectoryEndInfo endInfo)
               throws IOException

Finish writing the Zip-file with a comment. This will write out the central-directory file-headers at the end of the Zip-file that have been accumulated from the writeFileHeader(ZipFileHeader) and addDirectoryFileInfo(ZipCentralDirectoryFileInfo) methods. After the file-headers the directory-end information will be written either in Zip32 or Zip64 mode and lastly, if the end-info is in Zip64 mode, the Zip64 locator.

Returns:

Returns the number of bytes written to the stream so far.

Throws:

IOException

getNumBytesWritten

public long getNumBytesWritten()

Return the current number of bytes written to the output zip-file stream.

flush

public void flush()
           throws IOException

Flush the associated output stream.

Throws:

IOException

close

public void close()
           throws IOException

Close the associated output stream. If finishZip() has not been called then it will be called at this point.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException