eve.io.filestore

Class ZepStore

java.lang.Object

eve.io.filestore.ZepStore

All Implemented Interfaces:

FileStore

public class ZepStore
extends Object
implements FileStore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZepStore.CompressOptions This is used with MakeZepStore.add()
static class	ZepStore.MakeZepStore This is used to add files to a new ZepStore.

Nested classes/interfaces inherited from interface eve.io.filestore.FileStore

FileStore.Util

Constructor Summary

Constructors

Constructor and Description
ZepStore(RandomStream in, String name) Create a ZepStore for reading from a open RandomStream.

Method Summary

Modifier and Type	Method and Description
void	close()
FileStoreEntry	findEntry(String fullName)
static ZepStore.CompressOptions	getDefaultCompressionOptions()
int	getEntryCount() If the count is known then return the number of entries, otherwise return -1.
FileStoreEntryFile	getFileSystem(Handle h)
FileStoreEntry	getNewEntry(String forName)
static ZepStore.CompressOptions	getNoCompressionOptions()
Enumeration	getStoreEntries() Get an enumeration to go through the entries in the file.
Hashtable	getStoreHashtable() Expose the hashtable of entries if available.
String	getStoreName()
InputStream	openInputStream(FileStoreEntry entry)
RandomStream	openReadableRandomStream(FileStoreEntry entry)
static ZepStore.MakeZepStore	startZepStore(RandomStream out) Use this to start building a ZepStore compatible file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZepStore

public ZepStore(RandomStream in,
                String name)
         throws IOException

Create a ZepStore for reading from a open RandomStream.

Parameters:

in - the open RandomStream.

name - a descriptive name for the ZepFile.

Throws:

IOException

Method Detail

startZepStore

public static ZepStore.MakeZepStore startZepStore(RandomStream out)
                                           throws IOException

Use this to start building a ZepStore compatible file.

Parameters:

out - a newly opened RandomStream for writing to the ZepStore.

Returns:

a MakeZepStore Object for adding data and then ending the ZepStore.

Throws:

IOException

getNoCompressionOptions

public static ZepStore.CompressOptions getNoCompressionOptions()

getDefaultCompressionOptions

public static ZepStore.CompressOptions getDefaultCompressionOptions()

close

public void close()
           throws IOException

Specified by:

close in interface FileStore

Throws:

IOException

getEntryCount

public int getEntryCount()

Description copied from interface: FileStore

If the count is known then return the number of entries, otherwise return -1.

Specified by:

getEntryCount in interface FileStore

Returns:

the number of entries or -1 if not known.

openReadableRandomStream

public RandomStream openReadableRandomStream(FileStoreEntry entry)
                                      throws IOException

Throws:

IOException

openInputStream

public InputStream openInputStream(FileStoreEntry entry)
                            throws IOException

Specified by:

openInputStream in interface FileStore

Throws:

IOException

getStoreEntries

public Enumeration getStoreEntries()
                            throws IOException

Description copied from interface: FileStore

Get an enumeration to go through the entries in the file. Each entry provided is a FileStoreEntry.

Specified by:

getStoreEntries in interface FileStore

Throws:

IOException

getStoreHashtable

public Hashtable getStoreHashtable()
                            throws IOException

Description copied from interface: FileStore

Expose the hashtable of entries if available. The hashtable should consist of a set of FileStoreEntry objects each one stored with a key that is equal to the name of the entry.

Specified by:

getStoreHashtable in interface FileStore

Returns:

the hashtable of entries if available, or null if not available.

Throws:

IOException

getNewEntry

public FileStoreEntry getNewEntry(String forName)

Specified by:

getNewEntry in interface FileStore

getStoreName

public String getStoreName()

Specified by:

getStoreName in interface FileStore

findEntry

public FileStoreEntry findEntry(String fullName)

Specified by:

findEntry in interface FileStore

getFileSystem

public FileStoreEntryFile getFileSystem(Handle h)

Specified by:

getFileSystem in interface FileStore