com.facebook.buck.unarchive

Class UnarchiveStep

java.lang.Object

com.facebook.buck.unarchive.UnarchiveStep

All Implemented Interfaces:

Step

Direct Known Subclasses:

UntarStep, UnzipStep

public abstract class UnarchiveStep
extends Object
implements Step

A step that extracts arbitrary archives

Field Summary

Fields

Modifier and Type	Field and Description
protected Path	archiveFile
protected Path	destinationDirectory
protected PatternsMatcher	entriesToExclude
protected ProjectFilesystem	filesystem

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StepExecutionResult	execute(ExecutionContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.step.Step

getDescription, getShortName

Field Detail

filesystem

protected final ProjectFilesystem filesystem

archiveFile

protected final Path archiveFile

destinationDirectory

protected final Path destinationDirectory

entriesToExclude

protected final PatternsMatcher entriesToExclude

Constructor Detail

UnarchiveStep

public UnarchiveStep(ArchiveFormat format,
                     ProjectFilesystem filesystem,
                     Path archiveFile,
                     Path destinationDirectory,
                     Optional<Path> stripPrefix,
                     PatternsMatcher entriesToExclude)

Create an instance of UnarchiveStep

Parameters:

format - The type of file that will be extracted

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

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException,
                                   InterruptedException

Specified by:

execute in interface Step

Throws:

IOException

InterruptedException