com.facebook.buck.zip

Class RepackZipEntriesStep

java.lang.Object

com.facebook.buck.zip.RepackZipEntriesStep

All Implemented Interfaces:

Step

public class RepackZipEntriesStep
extends Object
implements Step

A command that creates a copy of a ZIP archive, making sure that certain user-specified entries are packed with a certain compression level.

Can be used, for instance, to force the resources.arsc file in an Android .apk to be compressed.

Constructor Summary

Constructors

Constructor and Description
RepackZipEntriesStep(ProjectFilesystem filesystem, Path inputPath, Path outputPath, com.google.common.collect.ImmutableSet<String> entries) Creates a RepackZipEntriesStep.
RepackZipEntriesStep(ProjectFilesystem filesystem, Path inputPath, Path outputPath, com.google.common.collect.ImmutableSet<String> entries, ZipCompressionLevel compressionLevel) Creates a RepackZipEntriesStep.

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

RepackZipEntriesStep

public RepackZipEntriesStep(ProjectFilesystem filesystem,
                            Path inputPath,
                            Path outputPath,
                            com.google.common.collect.ImmutableSet<String> entries)

Creates a RepackZipEntriesStep. A temporary directory will be created and used to extract entries. Entries will be packed with the maximum compression level.

Parameters:

inputPath - input archive

outputPath - destination archive

entries - files to repack (e.g. ImmutableSet.of("resources.arsc"))

RepackZipEntriesStep

public RepackZipEntriesStep(ProjectFilesystem filesystem,
                            Path inputPath,
                            Path outputPath,
                            com.google.common.collect.ImmutableSet<String> entries,
                            ZipCompressionLevel compressionLevel)

Creates a RepackZipEntriesStep.

Parameters:

inputPath - input archive

outputPath - destination archive

entries - files to repack (e.g. ImmutableSet.of("resources.arsc"))

compressionLevel - the level of compression to use

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

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.

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step