com.facebook.buck.unarchive

Class UnzipStep

java.lang.Object

com.facebook.buck.unarchive.UnarchiveStep

com.facebook.buck.unarchive.UnzipStep

All Implemented Interfaces:

Step

public class UnzipStep
extends UnarchiveStep

A step that extracts zip archives

Field Summary

Fields inherited from class com.facebook.buck.unarchive.UnarchiveStep

archiveFile, destinationDirectory, entriesToExclude, filesystem

Constructor Summary

Constructors

Constructor and Description
UnzipStep(ProjectFilesystem filesystem, Path zipFile, Path destinationDirectory, Optional<Path> stripPrefix) Create an instance of UnzipStep
UnzipStep(ProjectFilesystem filesystem, Path zipFile, Path destinationDirectory, Optional<Path> stripPrefix, PatternsMatcher entriesToExclude) Create an instance of UnzipStep

Method Summary

Modifier and Type	Method and Description
String	getDescription(ExecutionContext context)
String	getShortName()

Methods inherited from class com.facebook.buck.unarchive.UnarchiveStep

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

UnzipStep

public UnzipStep(ProjectFilesystem filesystem,
                 Path zipFile,
                 Path destinationDirectory,
                 Optional<Path> stripPrefix)

Create an instance of UnzipStep

Parameters:

filesystem - The filesystem that the archive will be extracted into

zipFile - The path to the file to extract

destinationDirectory - The directory to extract files into

stripPrefix - If present, strip this prefix from paths inside of the archive

UnzipStep

public UnzipStep(ProjectFilesystem filesystem,
                 Path zipFile,
                 Path destinationDirectory,
                 Optional<Path> stripPrefix,
                 PatternsMatcher entriesToExclude)

Create an instance of UnzipStep

Parameters:

filesystem - The filesystem that the archive will be extracted into

zipFile - The path to the file to extract

destinationDirectory - The directory to extract files into

stripPrefix - If present, strip this prefix from paths inside of the archive

entriesToExclude - entries that match this matcher will not be extracted

Method Detail

getShortName

public String getShortName()

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getDescription

public String getDescription(ExecutionContext context)