com.j256.simplezip

Class ZipFileInput

java.lang.Object

com.j256.simplezip.ZipFileInput

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZipFileInput
extends Object
implements Closeable

Read in a Zip-file either from a File or an InputStream.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ZipFileInput.ZipFileDataInputStream Input stream that can be used to read data for a single Zip file-entry.

Constructor Summary

Constructors

Constructor and Description
ZipFileInput(File file) Read a Zip-file from a file.
ZipFileInput(InputStream inputStream) Read a Zip-file from an input-stream.
ZipFileInput(String path) Start reading a Zip-file from the file-path.

Method Summary

Modifier and Type	Method and Description
boolean	assignDirectoryFileEntryPermissions(ZipCentralDirectoryFileEntry entry) Assigns the file permissions from the current dir-entry to the File that was previously read by readFileDataToFile(File).
void	close() Close the underlying input-stream.
Iterator<ZipCentralDirectoryFileEntry>	directoryFileEntryIterator() Return an iterator that can be used to step across the central-directory file entries.
Iterator<ZipFileHeader>	fileHeaderIterator() Return an iterator that can be used to step across the file-headers.
ZipDataDescriptor	getCurrentDataDescriptor() After all of the Zip data has been read from the stream there may be an optional data-descriptor depending on whether or not the file-header has the GeneralPurposeFlag.DATA_DESCRIPTOR flag set.
ZipFileDataInfo	getCurrentFileCountingInfo() Return some counting and CRC information from the current file that was read.
String	getCurrentFileName() Return the file-name from the most recent header read or null if none.
long	getNumBytesRead() Return the number of bytes that have been read so far in the stream.
boolean	isFileDataEofReached() Returns true if the current file's data EOF has been reached.
InputStream	openFileDataInputStream(boolean raw) Get an input stream suitable for reading the bytes of a single Zip file-entry.
ZipCentralDirectoryEnd	readDirectoryEnd() Read the central-directory end which is after all of the central-directory file-headers at the very end of the Zip file.
boolean	readDirectoryFileEntriesAndAssignPermissions() Reads in all of the file-entries from the Zip central-directory and assigns the permissions on the files that were previously read by readFileDataToFile(File) and that matches the file-header written with the File.
ZipCentralDirectoryFileEntry	readDirectoryFileEntry() After all of the files have been read, you can read and examine the central-directory entries.
long	readFileData(OutputStream outputStream) Read file data from the Zip stream, decode it, and write it to the output-steam argument.
int	readFileDataPart(byte[] buffer) Read file data from the Zip stream and decode it into the buffer argument.
int	readFileDataPart(byte[] buffer, int offset, int length) Read file data from the Zip stream and decode it into the buffer argument.
long	readFileDataToFile(File outputFile) Read file data from the Zip stream, decode it, and write it to the file argument.
long	readFileDataToFile(String outputPath) Read file data from the Zip stream, decode it, and write it to the file path argument.
ZipFileHeader	readFileHeader() Read the next file header from the zip file.
long	readRawFileData(OutputStream outputStream) Read raw file data from the Zip stream, no decoding, and write it to the output-steam argument.
int	readRawFileDataPart(byte[] buffer) Read raw file data from the Zip stream, without decoding, into the buffer argument.
int	readRawFileDataPart(byte[] buffer, int offset, int length) Read raw file data from the Zip stream, without decoding, into the buffer argument.
long	readRawFileDataToFile(File outputFile) Read raw file data from the Zip stream, decode it, and write it to the file argument.
long	readRawFileDataToFile(String outputPath) Read raw file data from the Zip stream, decode it, and write it to the file path argument.
void	readToEndOfZip() In some circumstances we need to read to the EOF marker in case we are in an inner Zip file.
Zip64CentralDirectoryEnd	readZip64DirectoryEnd() Read the central-directory end which is after all of the central-directory file-headers at the very end of the Zip file.
Zip64CentralDirectoryEndLocator	readZip64DirectoryEndLocator() Read the central-directory end locator which is after the zip64 end structure.
void	setReadTillEof(boolean readTillEof) By default the reader will read to the end of the zip-file when close() is called if we are reading from an input-stream to handle the possibility of being a Zip within a Zip.
long	skipFileData() Skip over the file data in the zip.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileInput

public ZipFileInput(String path)
             throws FileNotFoundException

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

Throws:

FileNotFoundException

ZipFileInput

public ZipFileInput(File file)
             throws FileNotFoundException

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

Throws:

FileNotFoundException

ZipFileInput

public ZipFileInput(InputStream inputStream)

Read a Zip-file from an input-stream. You must call close() to close the stream when you are done.

Method Detail

readFileHeader

public ZipFileHeader readFileHeader()
                             throws IOException

Read the next file header from the zip file. This is first thing that you will call after opening the Zip file.

Throws:

IOException

fileHeaderIterator

public Iterator<ZipFileHeader> fileHeaderIterator()

Return an iterator that can be used to step across the file-headers. The iterator will return false for Iterator.hasNext() and null for Iterator.next() once the end has been reached.

skipFileData

public long skipFileData()
                  throws IOException

Skip over the file data in the zip.

Returns:

The number of bytes skipped.

Throws:

IOException

readFileDataToFile

public long readFileDataToFile(String outputPath)
                        throws IOException

Read file data from the Zip stream, decode it, and write it to the file path argument.

Parameters:

outputPath - Where to write the data read from the zip stream.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

readFileDataToFile

public long readFileDataToFile(File outputFile)
                        throws IOException

Read file data from the Zip stream, decode it, and write it to the file argument. This will associate the File with the current header file-name so you can call assign the permissions for the file with a later call to assignDirectoryFileEntryPermissions(ZipCentralDirectoryFileEntry) or readDirectoryFileEntriesAndAssignPermissions().

Parameters:

outputFile - Where to write the data read from the zip stream.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

readFileData

public long readFileData(OutputStream outputStream)
                  throws IOException

Read file data from the Zip stream, decode it, and write it to the output-steam argument.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

readRawFileData

public long readRawFileData(OutputStream outputStream)
                     throws IOException

Read raw file data from the Zip stream, no decoding, and write it to the output-steam argument.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

openFileDataInputStream

public InputStream openFileDataInputStream(boolean raw)

Get an input stream suitable for reading the bytes of a single Zip file-entry. A call to the InputStream.read(byte[], int, int) basically calls through to readFileDataPart(byte[], int, int). NOTE: you _must_ read from the input-stream until it returns EOF (-1).

Parameters:

raw - Set to true to have read() call thru to readRawFileDataPart(byte[], int, int) or false to have it call thru to readFileDataPart(byte[], int, int).

Returns:

Stream that can be used to read the file bytes. Calling close() on this stream is a no-op.

readFileDataPart

public int readFileDataPart(byte[] buffer)
                     throws IOException

Read file data from the Zip stream and decode it into the buffer argument. See readFileDataPart(byte[], int, int) for more details.

Returns:

The number of bytes written into the buffer or -1 if the end of zipped bytes for this file have been reached. This doesn't mean that the end of the file has been reached.

Throws:

IOException

readRawFileDataToFile

public long readRawFileDataToFile(String outputPath)
                           throws IOException

Read raw file data from the Zip stream, decode it, and write it to the file path argument.

Parameters:

outputPath - Where to write the data read from the zip stream.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

readRawFileDataToFile

public long readRawFileDataToFile(File outputFile)
                           throws IOException

Read raw file data from the Zip stream, decode it, and write it to the file argument. This will associate the File with the current header file-name so you can call assign the permissions for the file with a later call to assignDirectoryFileEntryPermissions(ZipCentralDirectoryFileEntry) or readDirectoryFileEntriesAndAssignPermissions().

Parameters:

outputFile - Where to write the data read from the zip stream.

Returns:

THe number of bytes written into the output-stream.

Throws:

IOException

readRawFileDataPart

public int readRawFileDataPart(byte[] buffer)
                        throws IOException

Read raw file data from the Zip stream, without decoding, into the buffer argument. See readRawFileDataPart(byte[], int, int) for more details.

Returns:

The number of bytes written into the buffer or -1 if the end of zipped bytes for this file have been reached. This doesn't mean that the end of the file has been reached.

Throws:

IOException

readFileDataPart

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

Read file data from the Zip stream and decode it into the buffer argument. NOTE: This _must_ be called until it returns -1 which indicates that EOF has been reached. Until the underlying decoders return EOF we don't know that we are done and we can't rewind over any pre-fetched bytes to continue to process the next file or the directory at the end of the Zip file.

Returns:

The number of bytes written into the buffer or -1 if the end of zipped bytes for this file have been reached. This doesn't mean that the end of the file has been reached.

Throws:

IOException

readRawFileDataPart

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

Read raw file data from the Zip stream, without decoding, into the buffer argument. This will only work if the compressed-size value is set in the file-header. NOTE: This _must_ be called until it returns -1 which indicates that EOF has been reached. Until the underlying decoders return EOF we don't know that we are done and we can't rewind over any pre-fetched bytes to continue to process the next file or the directory at the end of the Zip file.

Returns:

The number of bytes written into the buffer or -1 if the end of zipped bytes for this file have been reached. This doesn't mean that the end of the file has been reached.

Throws:

IOException

readDirectoryFileEntry

public ZipCentralDirectoryFileEntry readDirectoryFileEntry()
                                                    throws IOException

After all of the files have been read, you can read and examine the central-directory entries.

Returns:

The next central-directory file-header or null if all entries have been read.

Throws:

IOException

directoryFileEntryIterator

public Iterator<ZipCentralDirectoryFileEntry> directoryFileEntryIterator()

Return an iterator that can be used to step across the central-directory file entries. The iterator will return false for Iterator.hasNext() and null for Iterator.next() once the end has been reached.

assignDirectoryFileEntryPermissions

public boolean assignDirectoryFileEntryPermissions(ZipCentralDirectoryFileEntry entry)

Assigns the file permissions from the current dir-entry to the File that was previously read by readFileDataToFile(File). A previous call to readDirectoryFileEntry() must have been made with a file-name that matches the file-header written with the File previously. This assigns the permissions based on a call to ExternalFileAttributesUtils.assignToFile(File, int).

Returns:

True if successful otherwise false if the file was not found.

readDirectoryFileEntriesAndAssignPermissions

public boolean readDirectoryFileEntriesAndAssignPermissions()
                                                     throws IOException

Reads in all of the file-entries from the Zip central-directory and assigns the permissions on the files that were previously read by readFileDataToFile(File) and that matches the file-header written with the File.

Returns:

True if successful or false if any of the files were not found.

Throws:

IOException

readZip64DirectoryEnd

public Zip64CentralDirectoryEnd readZip64DirectoryEnd()
                                               throws IOException

Read the central-directory end which is after all of the central-directory file-headers at the very end of the Zip file.

Returns:

The zip64 end or null if there is none.

Throws:

IOException

readZip64DirectoryEndLocator

public Zip64CentralDirectoryEndLocator readZip64DirectoryEndLocator()
                                                             throws IOException

Read the central-directory end locator which is after the zip64 end structure.

Returns:

The zip64 locator or null if there is none.

Throws:

IOException

readDirectoryEnd

public ZipCentralDirectoryEnd readDirectoryEnd()
                                        throws IOException

Read the central-directory end which is after all of the central-directory file-headers at the very end of the Zip file.

Throws:

IOException

readToEndOfZip

public void readToEndOfZip()
                    throws IOException

In some circumstances we need to read to the EOF marker in case we are in an inner Zip file. The outer decoder might need to hit the EOF so it can appropriately rewind in case it was reading ahead which happens when we are decoding file data or looking for data block magic numbers. This method will be called by close() if setReadTillEof(boolean) is set to true which is on by default if the ZipFileInput(InputStream) constructor is used.

Throws:

IOException

close

public void close()
           throws IOException

Close the underlying input-stream. NOTE: this will read to the end of the Zip-file if the read-till-eof flag is set to true. See setReadTillEof(boolean).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getCurrentFileName

public String getCurrentFileName()

Return the file-name from the most recent header read or null if none.

getCurrentFileCountingInfo

public ZipFileDataInfo getCurrentFileCountingInfo()

Return some counting and CRC information from the current file that was read.

getNumBytesRead

public long getNumBytesRead()

Return the number of bytes that have been read so far in the stream.

isFileDataEofReached

public boolean isFileDataEofReached()

Returns true if the current file's data EOF has been reached. read() should have returned -1.

getCurrentDataDescriptor

public ZipDataDescriptor getCurrentDataDescriptor()

After all of the Zip data has been read from the stream there may be an optional data-descriptor depending on whether or not the file-header has the GeneralPurposeFlag.DATA_DESCRIPTOR flag set. If there is no descriptor then null is returned here. Once the next header is read this will return null until the end of the Zip data again has been reached by the next file entry.

setReadTillEof

public void setReadTillEof(boolean readTillEof)

By default the reader will read to the end of the zip-file when close() is called if we are reading from an input-stream to handle the possibility of being a Zip within a Zip. If we don't do this the encoding of the outer Zip file may not be fully read to the end which would cause processing issues.