org.wandora.topicmap.packageio

Interface PackageOutput

All Known Implementing Classes:

DirectoryPackageOutput, ZipPackageOutput

public interface PackageOutput

A package is a collection of data consisting of entries. Each entry has a name and data. Data is written with OutputStream to allow binary entries. A new entry is started by calling nextEntry with the entry name. After that an OutputStream that can be used to write the entry can be retrieved with getOutputStream. A new getOutputStream must be used once for each entry. See notes about order of entries in PackageInput.

Author:

olli

Method Summary

Modifier and Type	Method and Description
void	close() Closes the package.
java.io.OutputStream	getOutputStream() Gets the output stream for current entry.
java.lang.String	getSeparator() Returns file separator used by the PackageOutput.
java.lang.String	joinPath(java.lang.String path, java.lang.String name) Joins path and name.
void	nextEntry(java.lang.String name) Start a new entry in the package with the given name.
void	nextEntry(java.lang.String path, java.lang.String name) Start a new entry in the package with the given path and name.
void	removeEntry(java.lang.String name) Ensure entry will be removed.
void	removeEntry(java.lang.String path, java.lang.String name) Ensure entry will be removed.

Method Detail

nextEntry

void nextEntry(java.lang.String name)
        throws java.io.IOException

Start a new entry in the package with the given name.

Parameters:

name -

Throws:

java.io.IOException

nextEntry

void nextEntry(java.lang.String path,
               java.lang.String name)
        throws java.io.IOException

Start a new entry in the package with the given path and name.

Parameters:

path -

name -

Throws:

java.io.IOException

close

void close()
    throws java.io.IOException

Closes the package.

Throws:

java.io.IOException

getOutputStream

java.io.OutputStream getOutputStream()
                              throws java.io.IOException

Gets the output stream for current entry.

Returns:

Throws:

java.io.IOException

removeEntry

void removeEntry(java.lang.String name)
          throws java.io.IOException

Ensure entry will be removed.

Parameters:

name -

Throws:

java.io.IOException

removeEntry

void removeEntry(java.lang.String path,
                 java.lang.String name)
          throws java.io.IOException

Ensure entry will be removed.

Parameters:

path -

name -

Throws:

java.io.IOException

getSeparator

java.lang.String getSeparator()

Returns file separator used by the PackageOutput.

Returns:

joinPath

java.lang.String joinPath(java.lang.String path,
                          java.lang.String name)

Joins path and name.

Parameters:

path -

name -

Returns: