org.eclipse.jgit.pgm.archive

Class ArchiveCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<OutputStream>

org.eclipse.jgit.pgm.archive.ArchiveCommand

All Implemented Interfaces:

Callable<OutputStream>

public class ArchiveCommand
extends GitCommand<OutputStream>

Create an archive of files from a named tree.

Examples (git is a Git instance):

Create a tarball from HEAD:

 cmd = new ArchiveCommand(git.getRepository());
 try {
        cmd.setTree(db.resolve("HEAD"))
                .setOutputStream(out).call();
 } finally {
        cmd.release();
 }
 

Create a ZIP file from master:

 try {
        cmd.setTree(db.resolve("master"))
                .setFormat(ArchiveCommand.Format.ZIP)
                .setOutputStream(out).call();
 } finally {
        cmd.release();
 }
 

Since:

3.0

See Also:

Git documentation about archive

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArchiveCommand.Format Available archival formats (corresponding to values for the --format= option)

Field Summary

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Constructor and Description
ArchiveCommand(Repository repo)

Method Summary

Methods

Modifier and Type	Method and Description
OutputStream	call()
void	release() Release any resources used by the internal ObjectReader.
ArchiveCommand	setFormat(ArchiveCommand.Format fmt)
ArchiveCommand	setOutputStream(OutputStream out)
ArchiveCommand	setTree(ObjectId tree)

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveCommand

public ArchiveCommand(Repository repo)

Parameters:

repo -

Method Detail

release

public void release()

Release any resources used by the internal ObjectReader.

This does not close the output stream set with setOutputStream, which belongs to the caller.

call

public OutputStream call()
                  throws GitAPIException

Specified by:

call in interface Callable<OutputStream>

Specified by:

call in class GitCommand<OutputStream>

Returns:

the stream to which the archive has been written

Throws:

GitAPIException

setTree

public ArchiveCommand setTree(ObjectId tree)
                       throws IOException

Parameters:

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

Returns:

this

Throws:

IOException

setOutputStream

public ArchiveCommand setOutputStream(OutputStream out)

Parameters:

out - the stream to which to write the archive

Returns:

this

setFormat

public ArchiveCommand setFormat(ArchiveCommand.Format fmt)

Parameters:

fmt - archive format (e.g., Format.TAR)

Returns:

this