com.facebook.buck.util.unarchive

Class Unzip

java.lang.Object

com.facebook.buck.util.unarchive.Unarchiver

com.facebook.buck.util.unarchive.Unzip

public class Unzip
extends Unarchiver

A simple utility class that extracts zip files

Constructor Summary

Constructors

Constructor and Description
Unzip()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<Path>	extractArchive(Path archiveFile, ProjectFilesystem filesystem, Path relativePath, Optional<Path> stripPrefix, PatternsMatcher entriesToExclude, ExistingFileMode existingFileMode) Unzips a file to a destination and returns the paths of the written files.
static com.google.common.collect.ImmutableSet<Path>	getZipMembers(Path archiveAbsolutePath) Gets a set of files that are contained in an archive

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

Constructor Detail

Unzip

public Unzip()

Method Detail

extractArchive

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

Unzips a file to a destination and returns the paths of the written files.

Specified by:

extractArchive in class Unarchiver

Parameters:

archiveFile - The path to the archive

filesystem - The filesystem that will be extracted into

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

stripPrefix - 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

getZipMembers

public static com.google.common.collect.ImmutableSet<Path> getZipMembers(Path archiveAbsolutePath)
                                                                  throws IOException

Gets a set of files that are contained in an archive

Parameters:

archiveAbsolutePath - The absolute path to the archive

Returns:

A set of files (not directories) that are contained in the zip file

Throws:

IOException - If there is an error reading the archive