* Examples (git is a {@link 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");
* }
*
*
* @see Git
* documentation about archive
*
* @since 3.1
*/
public class ArchiveCommand extends GitCommand* 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. * * @param name name of a format (e.g., "tar" or "zip"). * @param fmt archiver for that format * @throws JGitInternalException * A different archival format with that name was * already registered. */ public static void registerFormat(String name, Format fmt) { if (fmt == null) throw new NullPointerException(); FormatEntry old, entry; do { old = formats.get(name); if (old == null) { entry = new FormatEntry(fmt, 1); continue; } if (!old.format.equals(fmt)) throw new JGitInternalException(MessageFormat.format( JGitText.get().archiveFormatAlreadyRegistered, name)); entry = new FormatEntry(old.format, old.refcnt + 1); } while (!replace(formats, name, old, entry)); } /** * 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.
*
* @param name name of format (e.g., "tar" or "zip").
* @throws JGitInternalException
* No such archival format was registered.
*/
public static void unregisterFormat(String name) {
FormatEntry old, entry;
do {
old = formats.get(name);
if (old == null)
throw new JGitInternalException(MessageFormat.format(
JGitText.get().archiveFormatAlreadyAbsent,
name));
if (old.refcnt == 1) {
entry = null;
continue;
}
entry = new FormatEntry(old.format, old.refcnt - 1);
} while (!replace(formats, name, old, entry));
}
private static Format formatBySuffix(String filenameSuffix)
throws UnsupportedFormatException {
if (filenameSuffix != null)
for (FormatEntry entry : formats.values()) {
Format fmt = entry.format;
for (String sfx : fmt.suffixes())
if (filenameSuffix.endsWith(sfx))
return fmt;
}
return lookupFormat("tar"); //$NON-NLS-1$
}
private static Format lookupFormat(String formatName) throws UnsupportedFormatException {
FormatEntry entry = formats.get(formatName);
if (entry == null)
throw new UnsupportedFormatException(formatName);
return entry.format;
}
private OutputStream out;
private ObjectId tree;
private String prefix;
private String format;
private Mapfile1.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.
* @return this
* @since 3.4
*/
public ArchiveCommand setPaths(String... paths) {
this.paths = Arrays.asList(paths);
return this;
}
}