Package com.pnfsoftware.jeb.util.encoding.zip

Class ZipBrowserPNF

java.lang.Object

com.pnfsoftware.jeb.util.encoding.zip.ZipBrowserPNF

All Implemented Interfaces:

IGenericZipBrowser, AutoCloseable

public class ZipBrowserPNF
extends Object
implements IGenericZipBrowser

An implementation of a Zip browser backed by JEB's custom fail-safe Zip reader.

Constructor Summary

Constructors

Constructor	Description
ZipBrowserPNF(File f, int treatUnsupportedCompressionAsMethod, boolean ignoreEncryption)	Open a Zip archive with the custom fail-safe reader.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the archive browser and release its backing resources.
Map<String,GenericZipEntry<?>>	getEntries()	Get the archive entries indexed by entry name.
GenericZipEntry<?>	getEntry(String name)	Get an archive entry by name.
InputStream	getEntryStream(String name)	Open a stream for an archive entry.
byte[]	readEntry(String name)	Read and decompress an archive entry.

Methods inherited from class java.lang.Object

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

Constructor Details

ZipBrowserPNF

public ZipBrowserPNF(File f,
 int treatUnsupportedCompressionAsMethod,
 boolean ignoreEncryption)
              throws IOException

Open a Zip archive with the custom fail-safe reader.

Parameters:

f - Zip file

treatUnsupportedCompressionAsMethod - -1 to fail if unsupported, else a compression method id (0:treat as STORED; 8: treat as DEFLATED, etc.)

ignoreEncryption - true to ignore encrypted-entry flags

Throws:

IOException - if the archive cannot be opened

Method Details

close

public void close()
           throws IOException

Description copied from interface: IGenericZipBrowser

Close the archive browser and release its backing resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IGenericZipBrowser

Throws:

IOException - if closing failed

getEntries

public Map<String,GenericZipEntry<?>> getEntries()

Description copied from interface: IGenericZipBrowser

Get the archive entries indexed by entry name.

Specified by:

getEntries in interface IGenericZipBrowser

Returns:

entry map

getEntry

public GenericZipEntry<?> getEntry(String name)

Description copied from interface: IGenericZipBrowser

Get an archive entry by name.

Specified by:

getEntry in interface IGenericZipBrowser

Parameters:

name - entry name

Returns:

entry descriptor, or null

readEntry

public byte[] readEntry(String name)
                 throws IOException

Description copied from interface: IGenericZipBrowser

Read and decompress an archive entry.

Specified by:

readEntry in interface IGenericZipBrowser

Parameters:

name - entry name

Returns:

decompressed entry bytes

Throws:

IOException - if the entry cannot be read

getEntryStream

public InputStream getEntryStream(String name)
                           throws IOException

Description copied from interface: IGenericZipBrowser

Open a stream for an archive entry.

Specified by:

getEntryStream in interface IGenericZipBrowser

Parameters:

name - entry name

Returns:

stream yielding decompressed entry bytes

Throws:

IOException - if the entry cannot be opened