BasicZipFile (TrueZIP 6.8.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

TrueZIP 6.8.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.schlichtherle.util.zip
Class BasicZipFile

java.lang.Object
  de.schlichtherle.util.zip.BasicZipFile

Direct Known Subclasses:: ZipFile, ZipInputArchive

public class BasicZipFile
extends Object
extends Object

This class is not intended for public use! The methods in this class are unsynchronized and entries/getEntry(java.lang.String) enumerate/return ZipEntry instances which are shared with this class rather than clones of them. This class is used within other parts of the TrueZIP API in order to benefit from the slightly better performance.

Where the constructors of this class accept a charset parameter, this is used to decode comments and entry names in the ZIP file. However, if an entry has bit 11 set in its General Purpose Bit Flag, then this parameter is ignored and "UTF-8" is used for this entry. This is in accordance to Appendix D of PKWARE's ZIP File Format Specification, version 6.3.0 and later.

This class is able to skip a preamble like the one found in self extracting archives.

Note that the entries returned by this class are instances of de.schlichtherle.util.zip.ZipEntry instead of java.util.zip.ZipEntry.

Since:: TrueZIP 6.4
Version:: $Id: BasicZipFile.java cf6a93c1e429 2010/11/07 14:28:47 christian $
Author:: Christian Schlichtherle

Nested Class Summary
`private class`	`BasicZipFile.AccountedInputStream`
`private static class`	`BasicZipFile.CheckedInputStream`
`private class`	`BasicZipFile.IntervalInputStream` InputStream that delegates requests to the underlying RandomAccessFile, making sure that only bytes from a certain range can be read.
`private static class`	`BasicZipFile.IrregularOffsetMapper`
`private static class`	`BasicZipFile.OffsetMapper`
`private static class`	`BasicZipFile.PooledInflaterInputStream`
`private static class`	`BasicZipFile.RawCheckedInputStream` A stream which reads and returns deflated data from its input while a CRC-32 checksum is computed over the inflated data and checked in the method `close`.

Field Summary
`private ReadOnlyFile`	`archive` The actual data source.
`private String`	`charset` The charset to use for entry names and comments.
`private String`	`comment` The comment of this ZIP compatible file.
`static String`	`DEFAULT_CHARSET` The default character set used for entry names and comments in ZIP compatible files.
`private Map`	`entries` Maps entry names to zip entries.
`private static int`	`LFH_FILE_NAME_LENGTH_OFF`
`private static long`	`LONG_MSB`
`private BasicZipFile.OffsetMapper`	`mapper` Maps offsets specified in the ZIP file to real offsets in the file.
`private int`	`openStreams` The number of open streams reading from this ZIP compatible file.
`private long`	`postamble` The number of bytes in the postamble of this ZIP compatible file.
`private long`	`preamble` The number of bytes in the preamble of this ZIP compatible file.

Constructor Summary
	`BasicZipFile(File file)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(File file, String charset)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(File file, String charset, boolean preambled, boolean postambled)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(ReadOnlyFile rof)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
`private`	`BasicZipFile(ReadOnlyFile rof, File file, String charset, boolean preambled, boolean postambled)`
	`BasicZipFile(ReadOnlyFile rof, String charset)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(ReadOnlyFile rof, String charset, boolean preambled, boolean postambled)` Opens the given `ReadOnlyFile` for reading its entries.
	`BasicZipFile(String name)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(String name, String charset)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.
	`BasicZipFile(String name, String charset, boolean preambled, boolean postambled)` Deprecated. Use `new` `BasicZipFile(ReadOnlyFile, String, boolean, boolean)` instead.

Method Summary
`boolean`	`busy()` Returns `true` if and only if some input streams are open to read from this ZIP compatible file.
`void`	`close()` Closes the file.
`protected ReadOnlyFile`	`createReadOnlyFile(File file)` Deprecated. This method is unsafe because it's called by some constructors. Use a constructor with a `ReadOnlyFile` parameter instead.
`protected ZipEntry`	`createZipEntry(String name)` Deprecated. This method is called from a constructor! It will be replaced by a factory interface in TrueZIP 7.
`private void`	`ensureOpen()` Ensures that this archive is still open.
`Enumeration`	`entries()` Returns an enumeration of the ZIP entries in this ZIP file.
`private int`	`findCentralDirectory(ReadOnlyFile rof, boolean preambled, boolean postambled)` Positions the file pointer at the first Central File Header.
`private static int`	`getBufferSize(ZipEntry entry)`
`String`	`getCharset()` Returns the charset to use for entry names and comments.
`InputStream`	`getCheckedInputStream(String name)` Equivalent to `getInputStream(name, true, true)`.
`InputStream`	`getCheckedInputStream(ZipEntry entry)` Equivalent to `getInputStream(entry.getName(), true, true)` instead.
`String`	`getComment()` Returns the comment of this ZIP compatible file or `null` if no comment exists.
`ZipEntry`	`getEntry(String name)` Returns the `ZipEntry` for the given name or `null` if no entry with that name exists.
`InputStream`	`getInputStream(String name)` Equivalent to `getInputStream(name, false, true)`.
`InputStream`	`getInputStream(String name, boolean inflate)` Deprecated.
`protected InputStream`	`getInputStream(String name, boolean check, boolean inflate)` Returns an `InputStream` for reading the inflated or deflated data of the given entry.
`InputStream`	`getInputStream(ZipEntry entry)` Equivalent to `getInputStream(entry.getName(), false, true)` instead.
`InputStream`	`getInputStream(ZipEntry entry, boolean inflate)` Deprecated.
`InputStream`	`getPostambleInputStream()` Returns an `BasicZipFile.PooledInflaterInputStream` to read the postamble of this ZIP compatible file.
`long`	`getPostambleLength()` Returns the length of the postamble of this ZIP compatible file in bytes.
`InputStream`	`getPreambleInputStream()` Returns an `BasicZipFile.PooledInflaterInputStream` to read the preamble of this ZIP compatible file.
`long`	`getPreambleLength()` Returns the length of the preamble of this ZIP compatible file in bytes.
`long`	`length()` Returns the file length of this ZIP compatible file in bytes.
`private void`	`mountCentralDirectory(ReadOnlyFile rof, boolean preambled, boolean postambled)` Reads the central directory of the given file and populates the internal tables with ZipEntry instances.
`boolean`	`offsetsConsiderPreamble()` Returns `true` if and only if the offsets in this ZIP file are relative to the start of the file, rather than the first Local File Header.
`private void`	`setComment(String comment)`
`int`	`size()` Returns the number of entries in this ZIP compatible file.
`private static long`	`skipWithBuffer(InputStream in, long toSkip, byte[] buf)` This method skips `toSkip` bytes in the given input stream using the given buffer unless EOF or IOException.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

LONG_MSB

private static final long LONG_MSB

See Also:: Constant Field Values

LFH_FILE_NAME_LENGTH_OFF

private static final int LFH_FILE_NAME_LENGTH_OFF

See Also:: Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

The default character set used for entry names and comments in ZIP compatible files. This is "UTF-8" for compatibility with Sun's JDK implementation. Note that you should use "IBM437" for ordinary ZIP files instead.

See Also:: Constant Field Values

charset

private String charset

The charset to use for entry names and comments.

comment

private String comment

The comment of this ZIP compatible file.

entries

private final Map entries

Maps entry names to zip entries.

openStreams

private int openStreams

The number of open streams reading from this ZIP compatible file.

preamble

private long preamble

The number of bytes in the preamble of this ZIP compatible file.

postamble

private long postamble

The number of bytes in the postamble of this ZIP compatible file.

mapper

private BasicZipFile.OffsetMapper mapper

Maps offsets specified in the ZIP file to real offsets in the file.

Constructor Detail