com.facebook.buck.util.unarchive

Class Untar

java.lang.Object

com.facebook.buck.util.unarchive.Unarchiver

com.facebook.buck.util.unarchive.Untar

public class Untar
extends Unarchiver

Utility class to extract a .tar.* file

Method Summary

Modifier and Type	Method and Description
static Untar	bzip2Unarchiver()
com.google.common.collect.ImmutableSet<Path>	extractArchive(Path archiveFile, ProjectFilesystem filesystem, Path filesystemRelativePath, Optional<Path> stripPath, PatternsMatcher entriesToExclude, ExistingFileMode existingFileMode) Extract a given archive to a destination
static Untar	gzipUnarchiver()
static Untar	tarUnarchiver()
static Untar	xzUnarchiver()
static Untar	zstdUnarchiver()

Methods inherited from class com.facebook.buck.util.unarchive.Unarchiver

extractArchive, extractArchive, extractArchive, extractArchive

Methods inherited from class java.lang.Object

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

Method Detail

tarUnarchiver

public static Untar tarUnarchiver()

bzip2Unarchiver

public static Untar bzip2Unarchiver()

gzipUnarchiver

public static Untar gzipUnarchiver()

xzUnarchiver

public static Untar xzUnarchiver()

zstdUnarchiver

public static Untar zstdUnarchiver()

extractArchive

public com.google.common.collect.ImmutableSet<Path> extractArchive(Path archiveFile,
                                                                   ProjectFilesystem filesystem,
                                                                   Path filesystemRelativePath,
                                                                   Optional<Path> stripPath,
                                                                   PatternsMatcher entriesToExclude,
                                                                   ExistingFileMode existingFileMode)
                                                            throws IOException

Description copied from class: Unarchiver

Extract a given archive to a destination

Specified by:

extractArchive in class Unarchiver

Parameters:

archiveFile - The path to the archive

filesystem - The filesystem that will be extracted into

filesystemRelativePath - The path relative to the filesystem to extract files into

stripPath - If provided, only files under this prefix will be extracted. This prefix prefix will also be removed from the destination path. e.g. foo.tar.gz/foo/bar/baz with a prefix of foo will extract bar/baz into the destination directory. If not provided, no stripping is done.

entriesToExclude - Entries that match this matcher will not be extracted

existingFileMode - How to handle existing files

Returns:

A list of paths to files that were created (not directories)

Throws:

IOException - If the archive could not be extracted for any reason