com.facebook.buck.unarchive

Class UntarStep

java.lang.Object

com.facebook.buck.unarchive.UnarchiveStep

com.facebook.buck.unarchive.UntarStep

All Implemented Interfaces:

Step

public class UntarStep
extends UnarchiveStep

A step that extracts tar archives

Field Summary

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

archiveFile, destinationDirectory, entriesToExclude, filesystem

Constructor Summary

Constructors

Constructor and Description
UntarStep(ProjectFilesystem filesystem, Path archiveFile, Path destinationDirectory, Optional<Path> stripPrefix, ArchiveFormat format) Create an instance of UntarStep

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

UntarStep

public UntarStep(ProjectFilesystem filesystem,
                 Path archiveFile,
                 Path destinationDirectory,
                 Optional<Path> stripPrefix,
                 ArchiveFormat format)

Create an instance of UntarStep

Parameters:

filesystem - The filesystem that the archive will be extracted into

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

format - The format to extract

Throws:

RuntimeException - if a non-tar format is provided

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)