CompressionBase Class

Summary

Provides a CompressionBase class.
Assembly
Cake.Compression.dll
Namespace
Cake.Compression.Classes
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["CompressionBase"] class Type type-node Derived0["Zip"]-->Type click Derived0 "/api/Cake.Compression.Classes/Zip" Derived1["GZip"]-->Type click Derived1 "/api/Cake.Compression.Classes/GZip" Derived2["BZip2"]-->Type click Derived2 "/api/Cake.Compression.Classes/BZip2"

Syntax

public abstract class CompressionBase

Constructors

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

Fields

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

Methods

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

Extension Methods

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