de.schlichtherle.io.archive.spi
Interface InputArchive

All Known Implementing Classes:

CheckedJarInputArchive, CheckedZip32InputArchive, CheckedZipInputArchive, JarInputArchive, TarInputArchive, Zip32InputArchive, ZipInputArchive

public interface InputArchive

Defines the interface used to read entries from an archive file.

Implementations do not need to be thread safe: Multithreading is addressed in the package de.schlichtherle.io.

Since:

TrueZIP 6.0

Version:

$Id: InputArchive.java,v 1.4 2010/08/20 13:09:48 christian_schlichtherle Exp $

Author:

Christian Schlichtherle

Method Summary

void	close() Closes this input archive and releases any system resources associated with it.
Enumeration	getArchiveEntries() Returns an enumeration of the ArchiveEntry instances in this archive.
ArchiveEntry	getArchiveEntry(String entryName) Returns the ArchiveEntry for the given entry name or null if no entry with this name exists.
InputStream	getInputStream(ArchiveEntry entry, ArchiveEntry dstEntry) Returns a new InputStream for reading the contents of the given archive entry.
InputArchiveMetaData	getMetaData() Returns the meta data for this input archive.
int	getNumArchiveEntries() Returns the number of ArchiveEntry instances in this archive.
void	setMetaData(InputArchiveMetaData metaData) Sets the meta data for this input archive.

Method Detail

getNumArchiveEntries

int getNumArchiveEntries()

Returns the number of ArchiveEntry instances in this archive.

getArchiveEntries

Enumeration getArchiveEntries()

Returns an enumeration of the ArchiveEntry instances in this archive.

getArchiveEntry

ArchiveEntry getArchiveEntry(String entryName)

Returns the ArchiveEntry for the given entry name or null if no entry with this name exists.

Parameters:

entryName - A valid archive entry name - never null.

See Also:

Requirements for Archive Entry Names

getInputStream

InputStream getInputStream(ArchiveEntry entry,
                           ArchiveEntry dstEntry)
                           throws InputArchiveBusyException,
                                  FileNotFoundException,
                                  IOException

Returns a new InputStream for reading the contents of the given archive entry.

The returned stream should preferrably be unbuffered, as buffering is usually done in higher layers (all copy routines in TrueZIP do this and most client applications do it, too). Buffering twice does not increase, but decrease performance.

Note that the stream is guaranteed to be closed before the close() method of this archive is called!

Parameters:

entry - A valid reference to an archive entry. The runtime class of this entry is the same as the runtime class of the entries returned by getArchiveEntries().

dstEntry - If not null, this identifies the entry to which TrueZIP is actually copying data to and should be used to implement the Direct Data Copying (DDC) feature. Note that there is no guarantee on the runtime type of this object; it may have been created by other drivers.

For example, the ZIP driver family uses this to determine if data should be provided in its deflated form if the destination entry is another ZIP file entry.

Returns:

A (preferrably unbuffered) InputStream to read the archive entry data from. null is not allowed!

Throws:

InputArchiveBusyException - If the archive is currently busy on input for another entry. This exception is guaranteed to be recoverable, meaning it should be possible to read the same entry again as soon as the archive is not busy on input anymore.

FileNotFoundException - If the archive entry does not exist or is not accessible for some reason.

IOException - On any other exceptional condition.

close

void close()
           throws IOException

Closes this input archive and releases any system resources associated with it.

Throws:

IOException - On any I/O related issue.

getMetaData

InputArchiveMetaData getMetaData()

Returns the meta data for this input archive. The default value is null.

setMetaData

void setMetaData(InputArchiveMetaData metaData)

Sets the meta data for this input archive.

Parameters:

metaData - The meta data - may not be null.