Top Description Fields Constructors Methods
org.eclipse.jgit.archive

public final Class TxzFormat

extends BaseFormat
implements ArchiveCommand.Format<ArchiveOutputStream<TarArchiveEntry>>
Class Inheritance
All Implemented Interfaces
org.eclipse.jgit.api.ArchiveCommand.Format
Imports
java.io.IOException, .OutputStream, java.util.Arrays, .Collections, .List, .Map, org.apache.commons.compress.archivers.ArchiveOutputStream, org.apache.commons.compress.archivers.tar.TarArchiveEntry, org.apache.commons.compress.compressors.xz.XZCompressorOutputStream, org.eclipse.jgit.api.ArchiveCommand, org.eclipse.jgit.lib.FileMode, .ObjectId, .ObjectLoader
Xz-compressed tar (tar.xz) format.

Field Summary

Modifier and TypeField and Description
private static final List<String>
SUFFIXES

private final ArchiveCommand.Format<ArchiveOutputStream<TarArchiveEntry>>
tarFormat

Inherited from org.eclipse.jgit.archive.BaseFormat:
COMPRESSION_LEVEL

Constructor Summary

AccessConstructor and Description
public
TxzFormat()

Method Summary

Modifier and TypeMethod and Description
public ArchiveOutputStream<E extends ArchiveEntry>
createArchiveOutputStream(OutputStream
underlying output stream to which to write the archive.
s)

Implements org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

Start a new archive.

public ArchiveOutputStream<E extends ArchiveEntry>
createArchiveOutputStream(OutputStream
underlying output stream to which to write the archive.
s, Map<String, Object>
options to apply to the underlying output stream. Keys are option names and values are option values.
o)

Implements org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

Start a new archive.

public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
putEntry(ArchiveOutputStream<TarArchiveEntry>
archive object from createArchiveOutputStream
out, ObjectId
the tag, commit, or tree object to produce an archive for
tree, String
full filename relative to the root of the archive (with trailing '/' for directories)
path, FileMode
mode (for example FileMode.REGULAR_FILE or FileMode.SYMLINK)
mode, ObjectLoader
blob object with data for this entry (null for directories)
loader)

Implements org.eclipse.jgit.api.ArchiveCommand.Format.putEntry.

Write an entry to an archive.

public Iterable<String>
suffixes()

Implements org.eclipse.jgit.api.ArchiveCommand.Format.suffixes.

Filename suffixes representing this format (e.g., { ".tar.gz", ".tgz" }).

Inherited from org.eclipse.jgit.archive.BaseFormat:
applyFormatOptionsgetCompressionLevel

Field Detail

SUFFIXESback to summary
private static final List<String> SUFFIXES
tarFormatback to summary
private final ArchiveCommand.Format<ArchiveOutputStream<TarArchiveEntry>> tarFormat

Constructor Detail

TxzFormatback to summary
public TxzFormat()

Method Detail

createArchiveOutputStreamback to summary
public ArchiveOutputStream<E extends ArchiveEntry> createArchiveOutputStream(OutputStream s) throws IOException

Implements org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

Doc from org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

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.

Parameters
s:OutputStream

underlying output stream to which to write the archive.

Returns:ArchiveOutputStream<E extends ArchiveEntry>

new archive object for use in putEntry

Annotations
@Override
Exceptions
IOException:
thrown by the underlying output stream for I/O errors
createArchiveOutputStreamback to summary
public ArchiveOutputStream<E extends ArchiveEntry> createArchiveOutputStream(OutputStream s, Map<String, Object> o) throws IOException

Implements org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

Doc from org.eclipse.jgit.api.ArchiveCommand.Format.createArchiveOutputStream.

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. In addition options can be applied to the underlying stream. E.g. compression level.

Parameters
s:OutputStream

underlying output stream to which to write the archive.

o:Map<String, Object>

options to apply to the underlying output stream. Keys are option names and values are option values.

Returns:ArchiveOutputStream<E extends ArchiveEntry>

new archive object for use in putEntry

Annotations
@Override
Exceptions
IOException:
thrown by the underlying output stream for I/O errors
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
putEntryback to summary
public void putEntry(ArchiveOutputStream<TarArchiveEntry> out, ObjectId tree, String path, FileMode mode, ObjectLoader loader) throws IOException

Implements org.eclipse.jgit.api.ArchiveCommand.Format.putEntry.

Doc from org.eclipse.jgit.api.ArchiveCommand.Format.putEntry.

Write an entry to an archive.

Parameters
out:ArchiveOutputStream<TarArchiveEntry>

archive object from createArchiveOutputStream

tree:ObjectId

the tag, commit, or tree object to produce an archive for

path:String

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

mode:FileMode

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

loader:ObjectLoader

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

Annotations
@Override
Exceptions
IOException:
thrown by the underlying output stream for I/O errors
suffixesback to summary
public Iterable<String> suffixes()

Implements org.eclipse.jgit.api.ArchiveCommand.Format.suffixes.

Doc from org.eclipse.jgit.api.ArchiveCommand.Format.suffixes.

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").

Returns:Iterable<String>

this format's suffixes

Annotations
@Override