BZip2 Class

Summary

Provides a BZip2 class.
Assembly
Cake.Compression.dll
Namespace
Cake.Compression.Classes
Base Types
graph BT Type-->Base0["CompressionBase"] click Base0 "/api/Cake.Compression.Classes/CompressionBase" Base0-->Base1["Object"] Type["BZip2"] class Type type-node

Syntax

public class BZip2 : CompressionBase

Constructors

Name Summary
BZip2(IFileSystem, ICakeEnvironment, ICakeLog) Initializes a new instance of the BZip2 class.

Fields

Name Constant Value Summary
comparison
Gets the string comparison.
Inherited from CompressionBase
environment
Gets the environment.
Inherited from CompressionBase
fileSystem
Gets the file system.
Inherited from CompressionBase
log
Gets the log.
Inherited from CompressionBase

Methods

Name Value Summary
Compress(DirectoryPath, FilePath, IEnumerable<FilePath>, int) void
Create a BZip2 Tar archive of the specified files.
GetRelativeFilePath(DirectoryPath, FilePath) FilePath
Gets a relative file path.
Inherited from CompressionBase
Uncompress(FilePath, DirectoryPath) void
Uncompress the specified BZip2 Tar file.

Extension Methods

Name Value Summary
Dump<BZip2>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BZip2>(BZip2[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BZip2>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BZip2>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BZip2>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BZip2>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin