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

Class ZipBrowserOracle

java.lang.Object

com.pnfsoftware.jeb.util.encoding.zip.ZipBrowserOracle

All Implemented Interfaces:

IGenericZipBrowser, AutoCloseable

public class ZipBrowserOracle
extends Object
implements IGenericZipBrowser

An implementation of a Zip browser that uses the standard JDK implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	csnamesTrylist	Charset names attempted, in order, when auto-detecting entry-name encoding.

Constructor Summary

Constructors

Constructor	Description
ZipBrowserOracle(File f)	Open a zip archive and attempt to auto-detect character encoding for entry names.
ZipBrowserOracle(File f, Charset charset)	Open a zip archive and force the use of a given charset for entry names.

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

Field Details

csnamesTrylist

public static final String[] csnamesTrylist

Charset names attempted, in order, when auto-detecting entry-name encoding.

Constructor Details

ZipBrowserOracle

public ZipBrowserOracle(File f)
                 throws IOException

Open a zip archive and attempt to auto-detect character encoding for entry names. (Currently, only the entries in csnamesTrylist are tried).

Parameters:

f - Zip file

Throws:

IOException - if the archive cannot be opened

ZipBrowserOracle

public ZipBrowserOracle(File f,
 Charset charset)
                 throws IOException

Open a zip archive and force the use of a given charset for entry names.

Parameters:

f - Zip file

charset - charset used to decode entry names

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