org.eclipse.jgit.archive

Class TgzFormat

java.lang.Object

org.eclipse.jgit.archive.TgzFormat

All Implemented Interfaces:

ArchiveCommand.Format<org.apache.commons.compress.archivers.ArchiveOutputStream>

public final class TgzFormat
extends Object
implements ArchiveCommand.Format<org.apache.commons.compress.archivers.ArchiveOutputStream>

gzip-compressed tarball (tar.gz) format.

Constructor Summary

Constructors

Constructor and Description
TgzFormat()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.commons.compress.archivers.ArchiveOutputStream	createArchiveOutputStream(OutputStream s) Start a new archive.
boolean	equals(Object other)
int	hashCode()
void	putEntry(org.apache.commons.compress.archivers.ArchiveOutputStream out, String path, FileMode mode, ObjectLoader loader) Write an entry to an archive.
Iterable<String>	suffixes() Filename suffixes representing this format (e.g., { ".tar.gz", ".tgz" }).

Methods inherited from class java.lang.Object

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

Constructor Detail

TgzFormat

public TgzFormat()

Method Detail

createArchiveOutputStream

public org.apache.commons.compress.archivers.ArchiveOutputStream createArchiveOutputStream(OutputStream s)
                                                                                    throws IOException

Description copied from interface: ArchiveCommand.Format

Start a new archive. Entries can be included in the archive using the putEntry method, and then the archive should be closed using its close method.

Specified by:

createArchiveOutputStream in interface ArchiveCommand.Format<org.apache.commons.compress.archivers.ArchiveOutputStream>

Parameters:

s - underlying output stream to which to write the archive.

Returns:

new archive object for use in putEntry

Throws:

IOException - thrown by the underlying output stream for I/O errors

putEntry

public void putEntry(org.apache.commons.compress.archivers.ArchiveOutputStream out,
            String path,
            FileMode mode,
            ObjectLoader loader)
              throws IOException

Description copied from interface: ArchiveCommand.Format

Write an entry to an archive.

Specified by:

putEntry in interface ArchiveCommand.Format<org.apache.commons.compress.archivers.ArchiveOutputStream>

Parameters:

out - archive object from createArchiveOutputStream

path - full filename relative to the root of the archive (with trailing '/' for directories)

mode - mode (for example FileMode.REGULAR_FILE or FileMode.SYMLINK)

loader - blob object with data for this entry (null for directories)

Throws:

IOException - thrown by the underlying output stream for I/O errors

suffixes

public Iterable<String> suffixes()

Description copied from interface: ArchiveCommand.Format

Filename suffixes representing this format (e.g., { ".tar.gz", ".tgz" }). The behavior is undefined when suffixes overlap (if one format claims suffix ".7z", no other format should take ".tar.7z").

Specified by:

suffixes in interface ArchiveCommand.Format<org.apache.commons.compress.archivers.ArchiveOutputStream>

Returns:

this format's suffixes

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object