Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression.formats.tar

Class TapeArchiveInputStream

java.lang.Object

xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream

xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TapeArchiveInputStream
extends ArchiveInputStream

Support for reading (T)ape (AR)chive (TAR) files.

Implementation Notes

To better support unbuffered streams, this API is not random access. (That is, once an entry's header has been read, the content must be read by calling writeCurrentEntryTo(OutputStream) or skipped by calling getNextEntry()).

closeCurrentEntry() is a no-op. Close entries by calling getNextEntry() or close the stream by calling close(), instead.

tar (Wikipedia)

Field Summary

Fields inherited from class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream

stream

Constructor Summary

Constructors

Constructor	Description
TapeArchiveInputStream(@NonNull InputStream stream)	Construct a TapeArchiveInputStream that encapsulates the given InputStream.

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeCurrentEntry()	Close the current entry.
@Nullable ArchiveEntry	getNextEntry()	Get the next entry in the archive.
static boolean	isGzipStream(@NonNull InputStream stream)	Peek the first two bytes of the stream to see if they match the GZIP magic number.
static boolean	isTarStream(@NonNull InputStream stream)	Peek the first 512 bytes (TAR header) of the stream to see if the stream contains TAR data.
void	writeCurrentEntryTo(@NonNull OutputStream stream)	Write the current archive entry to the given OutputStream.

Methods inherited from class xyz.apollosoftware.bibliothiki.compression.ArchiveInputStream

detect

Methods inherited from class java.lang.Object

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

Constructor Details

TapeArchiveInputStream

public TapeArchiveInputStream(@NonNull InputStream stream)

Construct a TapeArchiveInputStream that encapsulates the given InputStream.

Parameters:

stream - The input stream that will provide tar data.

Method Details

isGzipStream

public static boolean isGzipStream(@NonNull InputStream stream)

Peek the first two bytes of the stream to see if they match the GZIP magic number.

Parameters:

stream - The stream to check.

Returns:

True, if the stream is a GZIP stream, otherwise false.

isTarStream

public static boolean isTarStream(@NonNull InputStream stream)

Peek the first 512 bytes (TAR header) of the stream to see if the stream contains TAR data.

Parameters:

stream - The stream to check.

Returns:

True, if the stream is a TAR stream, otherwise false.

getNextEntry

public @Nullable ArchiveEntry getNextEntry()

Description copied from class: ArchiveInputStream

Get the next entry in the archive.

If there are no (more) entries in the archive, this method returns null, instead.

Specified by:

getNextEntry in class ArchiveInputStream

Returns:

The ArchiveEntry, if there is one.

See Also:

• ArchiveEntry

writeCurrentEntryTo

public void writeCurrentEntryTo(@NonNull OutputStream stream)
                         throws IOException

Description copied from class: ArchiveInputStream

Write the current archive entry to the given OutputStream.

The ArchiveInputStream.getNextEntry() must have been called prior, or this method will throw a CompressionException.

A common pattern for writing to files, therefore, would be to invoke ArchiveInputStream.getNextEntry() and then write the file data with this method.

Some implementations may return a CompressionException for format or decompression failures. Implementations that do this will still return IOException when an exception is raised writing to the given output stream. In cases where it is not possible to disambiguate, an IOException is always thrown instead.

Specified by:

writeCurrentEntryTo in class ArchiveInputStream

Parameters:

stream - The stream to write the file data to.

Throws:

IOException - If writing to the given OutputStream fails with an IOException.

See Also:

• ArchiveInputStream.getNextEntry()

closeCurrentEntry

public void closeCurrentEntry()

Description copied from class: ArchiveInputStream

Close the current entry.

This may be a no-op for some implementations.

Specified by:

closeCurrentEntry in class ArchiveInputStream

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ArchiveInputStream