com.facebook.buck.zip

Class ZipStep

java.lang.Object

com.facebook.buck.zip.ZipStep

All Implemented Interfaces:

Step

public class ZipStep
extends Object
implements Step

A Step that creates a ZIP archive..

Constructor Summary

Constructors

Constructor and Description
ZipStep(ProjectFilesystem filesystem, Path pathToZipFile, Set<Path> paths, boolean junkPaths, ZipCompressionLevel compressionLevel, Path baseDir) Create a ZipStep to create or update a zip archive.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipStep

public ZipStep(ProjectFilesystem filesystem,
               Path pathToZipFile,
               Set<Path> paths,
               boolean junkPaths,
               ZipCompressionLevel compressionLevel,
               Path baseDir)

Create a ZipStep to create or update a zip archive.

Note that paths added to the archive are always relative to the working directory.
For example, if you're in /dir and you add file.txt, you get an archive containing just the file. If you were in / and added dir/file.txt, you would get an archive containing the file within a directory.

Parameters:

filesystem - project filesystem based in current working directory.

pathToZipFile - path to archive to create, relative to project root.

paths - a set of files to work on. The entire working directory is assumed if this set is empty.

junkPaths - if true, the relative paths of added archive entries are discarded, i.e. they are all placed in the root of the archive.

compressionLevel - between 0 (store) and 9.

baseDir - working directory for zip command.

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

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