org.povclipse2.wizards.helper

Class TarFile

java.lang.Object

org.povclipse2.wizards.helper.TarFile

public class TarFile
extends java.lang.Object

Reads a .tar or .tar.gz archive file, providing an index enumeration and allows for accessing an InputStream for arbitrary files in the archive.

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
TarFile(java.io.File file) Create a new TarFile for the given file.
TarFile(java.lang.String filename) Create a new TarFile for the given path name.

Method Summary

Modifier and Type	Method and Description
void	close() Close the tar file input stream.
java.util.Enumeration	entries() Returns an enumeration cataloguing the tar archive.
java.io.InputStream	getInputStream(TarEntry entry) Returns a new InputStream for the given file in the tar archive.
java.lang.String	getName() Returns the path name of the file this archive represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

TarFile

public TarFile(java.io.File file)
        throws TarException,
               java.io.IOException

Create a new TarFile for the given file.

Parameters:

file -

Throws:

TarException

java.io.IOException

TarFile

public TarFile(java.lang.String filename)
        throws TarException,
               java.io.IOException

Create a new TarFile for the given path name.

Parameters:

filename -

Throws:

TarException

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Close the tar file input stream.

Throws:

java.io.IOException - if the file cannot be successfully closed

entries

public java.util.Enumeration entries()

Returns an enumeration cataloguing the tar archive.

Returns:

enumeration of all files in the archive

getInputStream

public java.io.InputStream getInputStream(TarEntry entry)
                                   throws TarException,
                                          java.io.IOException

Returns a new InputStream for the given file in the tar archive.

Parameters:

entry -

Returns:

an input stream for the given file

Throws:

TarException

java.io.IOException

getName

public java.lang.String getName()

Returns the path name of the file this archive represents.

Returns:

path