Package org.codehaus.plexus.archiver.tar

Class TarFile

java.lang.Object

org.codehaus.plexus.archiver.tar.TarFile

All Implemented Interfaces:

ArchiveFile

Direct Known Subclasses:

BZip2TarFile, GZipTarFile, SnappyTarFile, XZTarFile, ZstdTarFile

public class TarFile
extends Object
implements ArchiveFile

Implementation of ArchiveFile for tar files.

Compared to ZipFile, this one should be used with some care, due to the nature of a tar file: While a zip file contains a catalog, a tar file does not. In other words, the only way to read a tar file in a performant manner is by iterating over it from the beginning to the end. If you try to open another entry than the "next" entry, then you force to skip entries, until the requested entry is found. This may require to reread the entire file!

In other words, the recommended use of this class is to use getEntries() and invoke getInputStream(TarArchiveEntry) only for the current entry. Basically, this is to handle it like TarArchiveInputStream.

The advantage of this class is that you may write code for the ArchiveFile, which is valid for both tar files and zip files.

Constructor Summary

Constructors

Constructor	Description
TarFile(File file)	Creates a new instance with the given file.

Method Summary

Modifier and Type	Method	Description
void	close()
Enumeration<org.apache.commons.compress.archivers.ArchiveEntry>	getEntries()	Implementation of ArchiveFile.getEntries().
protected InputStream	getInputStream(File file)
InputStream	getInputStream(org.apache.commons.compress.archivers.ArchiveEntry entry)	Returns an InputStream with the given entries contents.
InputStream	getInputStream(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)	Returns an InputStream with the given entries contents.

Methods inherited from class java.lang.Object

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

Constructor Details

TarFile

public TarFile(File file)

Creates a new instance with the given file.

Method Details

getEntries

public Enumeration<org.apache.commons.compress.archivers.ArchiveEntry> getEntries()
                                                                           throws IOException

Implementation of ArchiveFile.getEntries(). Note, that there is an interaction between this method and getInputStream(TarArchiveEntry), or getInputStream(org.apache.commons.compress.archivers.ArchiveEntry): If an input stream is opened for any other entry than the enumerations current entry, then entries may be skipped.

Specified by:

getEntries in interface ArchiveFile

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

getInputStream

public InputStream getInputStream(org.apache.commons.compress.archivers.ArchiveEntry entry)
                           throws IOException

Description copied from interface: ArchiveFile

Returns an InputStream with the given entries contents. org.apache.commons.compress.archivers.ArchiveEntry

Specified by:

getInputStream in interface ArchiveFile

Throws:

IOException

getInputStream

public InputStream getInputStream(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)
                           throws IOException

Returns an InputStream with the given entries contents. This InputStream may be closed: Nothing happens in that case, because an actual close would invalidate the underlying TarArchiveInputStream.

Throws:

IOException

getInputStream

protected InputStream getInputStream(File file)
                              throws IOException

Throws:

IOException