org.eclipse.jgit.api

Class ArchiveCommand

java.lang.Object

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

org.eclipse.jgit.api.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:

 ArchiveCommand.registerFormat("tar", new TarFormat());
 try {
        git.archive().setTree(db.resolve("HEAD")).setOutputStream(out).call();
 } finally {
        ArchiveCommand.unregisterFormat("tar");
 }
 

Create a ZIP file from master:

 ArchiveCommand.registerFormat("zip", new ZipFormat());
 try {
        git.archive().
                .setTree(db.resolve("master"))
                .setFormat("zip")
                .setOutputStream(out)
                .call();
 } finally {
        ArchiveCommand.unregisterFormat("zip");
 }
 

Since:

3.1

See Also:

Git documentation about archive

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArchiveCommand.Format<T extends Closeable> Archival format.
static class	ArchiveCommand.UnsupportedFormatException Signals an attempt to use an archival format that ArchiveCommand doesn't know about (for example due to a typo).

Field Summary

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

repo

Constructor Summary

Constructors

Constructor and Description
ArchiveCommand(Repository repo) Constructor for ArchiveCommand

Method Summary

Modifier and Type	Method and Description
OutputStream	call()
static void	registerFormat(String name, ArchiveCommand.Format<?> fmt) Adds support for an additional archival format.
ArchiveCommand	setFilename(String filename) Set the intended filename for the produced archive.
ArchiveCommand	setFormat(String fmt) Set archive format
ArchiveCommand	setFormatOptions(Map<String,Object> options) Set archive format options
ArchiveCommand	setOutputStream(OutputStream out) Set output stream
ArchiveCommand	setPaths(String... paths) Set an optional parameter path.
ArchiveCommand	setPrefix(String prefix) Set string prefixed to filenames in archive
ArchiveCommand	setTree(ObjectId tree) Set the tag, commit, or tree object to produce an archive for
static void	unregisterFormat(String name) Marks support for an archival format as no longer needed so its Format can be garbage collected if no one else is using it either.

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)

Constructor for ArchiveCommand

Parameters:

repo - the Repository

Method Detail

registerFormat

public static void registerFormat(String name,
                                  ArchiveCommand.Format<?> fmt)

Adds support for an additional archival format. To avoid unnecessary dependencies, ArchiveCommand does not have support for any formats built in; use this function to add them.

OSGi plugins providing formats should call this function at bundle activation time.

It is okay to register the same archive format with the same name multiple times, but don't forget to unregister it that same number of times, too.

Registering multiple formats with different names and the same or overlapping suffixes results in undefined behavior. TODO: check that suffixes don't overlap.

Parameters:

name - name of a format (e.g., "tar" or "zip").

fmt - archiver for that format

Throws:

JGitInternalException - A different archival format with that name was already registered.

unregisterFormat

public static void unregisterFormat(String name)

Marks support for an archival format as no longer needed so its Format can be garbage collected if no one else is using it either.

In other words, this decrements the reference count for an archival format. If the reference count becomes zero, removes support for that format.

Parameters:

name - name of format (e.g., "tar" or "zip").

Throws:

JGitInternalException - No such archival format was registered.

call

public OutputStream call()
                  throws GitAPIException

Execute the command

Specified by:

call in interface Callable<OutputStream>

Specified by:

call in class GitCommand<OutputStream>

Throws:

GitAPIException

setTree

public ArchiveCommand setTree(ObjectId tree)

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

Parameters:

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

Returns:

this

setPrefix

public ArchiveCommand setPrefix(String prefix)

Set string prefixed to filenames in archive

Parameters:

prefix - string prefixed to filenames in archive (e.g., "master/"). null means to not use any leading prefix.

Returns:

this

Since:

3.3

setFilename

public ArchiveCommand setFilename(String filename)

Set the intended filename for the produced archive. Currently the only effect is to determine the default archive format when none is specified with setFormat(String).

Parameters:

filename - intended filename for the archive

Returns:

this

setOutputStream

public ArchiveCommand setOutputStream(OutputStream out)

Set output stream

Parameters:

out - the stream to which to write the archive

Returns:

this

setFormat

public ArchiveCommand setFormat(String fmt)

Set archive format

Parameters:

fmt - archive format (e.g., "tar" or "zip"). null means to choose automatically based on the archive filename.

Returns:

this

setFormatOptions

public ArchiveCommand setFormatOptions(Map<String,Object> options)

Set archive format options

Parameters:

options - archive format options (e.g., level=9 for zip compression).

Returns:

this

Since:

4.0

setPaths

public ArchiveCommand setPaths(String... paths)

Set an optional parameter path. without an optional path parameter, all files and subdirectories of the current working directory are included in the archive. If one or more paths are specified, only these are included.

Parameters:

paths - file names (e.g file1.c) or directory names (e.g. dir to add dir/file1 and dir/file2) can also be given to add all files in the directory, recursively. Fileglobs (e.g. *.c) are not yet supported.

Returns:

this

Since:

3.4