com.facebook.buck.step.fs

Class XzStep

java.lang.Object

com.facebook.buck.step.fs.XzStep

All Implemented Interfaces:

Step

public class XzStep
extends Object
implements Step

A Step to compress a file with XZ / LZMA2.

See Also:

XZ, XZ for Java, XZ Embedded

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMPRESSION_LEVEL

Constructor Summary

Constructors

Constructor and Description
XzStep(ProjectFilesystem filesystem, Path sourceFile, int compressionLevel) Creates an XzStep to compress a file with XZ at a user supplied compression level .
XzStep(ProjectFilesystem filesystem, Path sourceFile, Path outputPath, int compressionLevel) Creates an XzStep to compress a file with the given XZ compression level and output path.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPRESSION_LEVEL

public static final int DEFAULT_COMPRESSION_LEVEL

See Also:

Constant Field Values

Constructor Detail

XzStep

public XzStep(ProjectFilesystem filesystem,
              Path sourceFile,
              Path outputPath,
              int compressionLevel)

Creates an XzStep to compress a file with the given XZ compression level and output path.

Decompression will require up to 64MiB of RAM.

Parameters:

sourceFile - file to compress

outputPath - the desired output path.

compressionLevel - level of compression (from 0-9)

XzStep

public XzStep(ProjectFilesystem filesystem,
              Path sourceFile,
              int compressionLevel)

Creates an XzStep to compress a file with XZ at a user supplied compression level .

The destination file will be sourceFile with the added .xz extension.

Decompression will require up to 64MiB of RAM.

Parameters:

sourceFile - file to compress

compressionLevel - value from 0 to 9. Higher values result in better compression, but also need more time to compress and will need more RAM to decompress.

Method Detail

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

getDestinationFile

public Path getDestinationFile()

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.