This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.7zip.

Summary

Builder for ExtractCommand.

Assembly

Cake.7zip.dll

Namespace

Cake.SevenZip.Builder

Interfaces

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["ISupportArgumentBuilder<IHaveArgumentArchive>"] Type-.->Interface1["ISupportSwitchBuilder<ISupportSwitchArchiveType>"] Type-.->Interface2["ISupportSwitchBuilder<ISupportSwitchCompressionMethod>"] Type-.->Interface3["ISupportSwitchBuilder<ISupportSwitchPassword>"] Type-.->Interface4["ISupportSwitchBuilder<ISupportSwitchNtSecurityInformation>"] Type-.->Interface5["ISupportSwitchBuilder<ISupportSwitchNtfsAlternateStreams>"] Type-.->Interface6["ISupportSwitchBuilder<ISupportSwitchRecurseSubdirectories>"] Type-.->Interface7["ISupportSwitchBuilder<ISupportSwitchIncludeFilenames>"] Type-.->Interface8["ISupportSwitchBuilder<ISupportSwitchExcludeFilenames>"] Type-.->Interface9["ISupportSwitchBuilder<ISupportSwitchIncludeArchiveFilenames>"] Type-.->Interface10["ISupportSwitchBuilder<ISupportSwitchExcludeArchiveFilenames>"] Type-.->Interface11["ISupportSwitchBuilder<ISupportSwitchDisableParsingOfArchiveName>"] Type-.->Interface12["ISupportSwitchBuilder<ISupportSwitchOverwriteMode>"] Type-.->Interface13["ISupportSwitchBuilder<ISupportSwitchOutputDirectory>"] Type-.->Interface14["ISupportSwitchBuilder<ISupportSwitchFullyQualifiedFilePaths>"] Type["ExtractCommandBuilder"] class Type type-node

Syntax

public sealed class ExtractCommandBuilder : ISupportArgumentBuilder<IHaveArgumentArchive>, 
    ISupportSwitchBuilder<ISupportSwitchArchiveType>, 
    ISupportSwitchBuilder<ISupportSwitchCompressionMethod>, 
    ISupportSwitchBuilder<ISupportSwitchPassword>, 
    ISupportSwitchBuilder<ISupportSwitchNtSecurityInformation>, 
    ISupportSwitchBuilder<ISupportSwitchNtfsAlternateStreams>, 
    ISupportSwitchBuilder<ISupportSwitchRecurseSubdirectories>, 
    ISupportSwitchBuilder<ISupportSwitchIncludeFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchExcludeFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchIncludeArchiveFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchExcludeArchiveFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchDisableParsingOfArchiveName>, 
    ISupportSwitchBuilder<ISupportSwitchOverwriteMode>, 
    ISupportSwitchBuilder<ISupportSwitchOutputDirectory>, 
    ISupportSwitchBuilder<ISupportSwitchFullyQualifiedFilePaths>

Examples

 Task("UnzipIt")
     .Does(() =>
 {
     SevenZip(m => m
       .InExtractMode()
       .WithArchive(File("path/to/file.zip"))
       .WithArchiveType(SwitchArchiveType.Zip)
       .WithOutputDirectory("some/other/directory"));
 });

 Task("UnzipVolumes")
     .Does(() =>
 {
     SevenZip(m => m
       .InExtractMode()
       .WithArchive(File("path/to/file.7z.001"))
       .WithArchiveType(SwitchArchiveType.SevenZip.Volumes())
       .WithOutputDirectory("some/other/directory"));
 });

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Methods

Name	Value	Summary
WithFullPathExtraction()	ExtractCommandBuilder	Sets UseFullPaths to true on the `ExtractCommand`.
WithoutFullPathExtraction()	ExtractCommandBuilder	Sets UseFullPaths to false on the `ExtractCommand`. (copies all extracted files to one directory).

Extension Methods

Name	Value	Summary
Dump<ExtractCommandBuilder>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<ExtractCommandBuilder>(ExtractCommandBuilder[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<ExtractCommandBuilder>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<ExtractCommandBuilder>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<ExtractCommandBuilder>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<ExtractCommandBuilder>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	From StringExtensions Requires the Cake.Issues addin