org.codehaus.plexus.archiver.zip

Class ZipFile

java.lang.Object

org.codehaus.plexus.archiver.zip.ZipFile

All Implemented Interfaces:

ArchiveFile

public class ZipFile
extends Object
implements ArchiveFile

Replacement for java.util.ZipFile.

This class adds support for file name encodings other than UTF-8 (which is required to work on ZIP files created by native zip tools and is able to skip a preamble like the one found in self extracting archives. Furthermore it returns instances of org.apache.tools.zip.ZipEntry instead of java.util.zip.ZipEntry.

It doesn't extend java.util.zip.ZipFile as it would have to reimplement all methods anyway. Like java.util.ZipFile, it uses RandomAccessFile under the covers and supports compressed and uncompressed entries.

The method signatures mimic the ones of java.util.zip.ZipFile, with a couple of exceptions:

• There is no getName method.
• entries has been renamed to getEntries.
• getEntries and getEntry return org.apache.tools.zip.ZipEntry instances.
• close is allowed to throw IOException.

Version:

$Revision$ $Date$ from org.apache.ant.tools.zip.ZipFile v1.13

Nested Class Summary

Nested classes/interfaces inherited from interface org.codehaus.plexus.archiver.ArchiveFile

ArchiveFile.Entry

Constructor Summary

Constructors

Constructor and Description
ZipFile(File f) Opens the given file for reading, assuming the platform's native encoding for file names.
ZipFile(File f, String encoding) Opens the given file for reading, assuming the specified encoding for file names.
ZipFile(String name) Opens the given file for reading, assuming the platform's native encoding for file names.
ZipFile(String name, String encoding) Opens the given file for reading, assuming the specified encoding for file names.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the archive.
protected static Date	fromDosTime(ZipLong l) Convert a DOS date/time field to a Date object.
String	getEncoding() The encoding to use for filenames and the file comment.
Enumeration<ZipEntry>	getEntries() Returns all entries.
ZipEntry	getEntry(String name) Returns a named entry - or null if no entry by that name exists.
InputStream	getInputStream(ArchiveFile.Entry entry) Returns an InputStream with the given entries contents.
InputStream	getInputStream(ZipEntry ze) Returns an InputStream for reading the contents of the given entry.
protected String	getString(byte[] bytes) Retrieve a String from the given bytes using the encoding set for this ZipFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFile

public ZipFile(File f)
        throws IOException

Opens the given file for reading, assuming the platform's native encoding for file names.

Parameters:

f - the archive.

Throws:

IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(String name)
        throws IOException

Opens the given file for reading, assuming the platform's native encoding for file names.

Parameters:

name - name of the archive.

Throws:

IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(String name,
       String encoding)
        throws IOException

Opens the given file for reading, assuming the specified encoding for file names.

Parameters:

name - name of the archive.

encoding - the encoding to use for file names

Throws:

IOException - if an error occurs while reading the file.

ZipFile

public ZipFile(File f,
       String encoding)
        throws IOException

Opens the given file for reading, assuming the specified encoding for file names.

Parameters:

f - the archive.

encoding - the encoding to use for file names

Throws:

IOException - if an error occurs while reading the file.

Method Detail

getEncoding

public String getEncoding()

The encoding to use for filenames and the file comment.

Returns:

null if using the platform's default character encoding.

close

public void close()
           throws IOException

Closes the archive.

Throws:

IOException - if an error occurs closing the archive.

getEntries

public Enumeration<ZipEntry> getEntries()

Returns all entries.

Specified by:

getEntries in interface ArchiveFile

Returns:

all entries as ZipEntry instances

getEntry

public ZipEntry getEntry(String name)

Returns a named entry - or null if no entry by that name exists.

Parameters:

name - name of the entry.

Returns:

the ZipEntry corresponding to the given name - or null if not present.

getInputStream

public InputStream getInputStream(ArchiveFile.Entry entry)
                           throws IOException

Description copied from interface: ArchiveFile

Returns an InputStream with the given entries contents.

Specified by:

getInputStream in interface ArchiveFile

Throws:

IOException

getInputStream

public InputStream getInputStream(ZipEntry ze)
                           throws IOException

Returns an InputStream for reading the contents of the given entry.

Parameters:

ze - the entry to get the stream for.

Returns:

a stream to read the entry from.

Throws:

IOException

fromDosTime

protected static Date fromDosTime(ZipLong l)

Convert a DOS date/time field to a Date object.

Parameters:

l - contains the stored DOS time.

Returns:

a Date instance corresponding to the given time.

getString

protected String getString(byte[] bytes)
                    throws ZipException

Retrieve a String from the given bytes using the encoding set for this ZipFile.

Parameters:

bytes - the byte array to transform

Returns:

String obtained by using the given encoding

Throws:

ZipException - if the encoding cannot be recognized.