ExtractCommandBuilder Class

Summary

Builder for ExtractCommand.
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"));
 });

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
WithArchive<ExtractCommandBuilder>(FilePath) T
fluent setter for Archive.
WithArchiveType<ExtractCommandBuilder>(SwitchArchiveType) T
fluent setter for ISupportSwitchArchiveType.
WithCompressionMethod<ExtractCommandBuilder>(Action<SwitchCompressionMethod>) T
fluent setter for ISupportSwitchCompressionMethod using an action.
WithCompressionMethodDictionarySize<ExtractCommandBuilder>(int) T
fluent setter for the method of ISupportSwitchCompressionMethod.
WithCompressionMethodLevel<ExtractCommandBuilder>(int) T
fluent setter for the method of ISupportSwitchCompressionMethod.
WithCompressionMethodMethod<ExtractCommandBuilder>(string) T
fluent setter for the method of ISupportSwitchCompressionMethod.
WithCompressionMethodSortFilesByType<ExtractCommandBuilder>(bool) T
fluent setter for the method of ISupportSwitchCompressionMethod.
WithDisableParsingOfArchiveName<ExtractCommandBuilder>() T
WithExcludeArchiveFilenames<ExtractCommandBuilder>(RecurseType, string, string[]) T
WithExcludeArchiveFilenames<ExtractCommandBuilder>(string, string[]) T
WithExcludeFilenames<ExtractCommandBuilder>(RecurseType, string, string[]) T
fluent setter for ISupportSwitchExcludeFilenames.
WithExcludeFilenames<ExtractCommandBuilder>(string, string[]) T
fluent setter for ISupportSwitchExcludeFilenames.
WithFullyQualifiedFilePaths<ExtractCommandBuilder>(bool) T
fluent setter for FullyQualifiedFilePaths.
WithIncludeArchiveFilenames<ExtractCommandBuilder>(RecurseType, string, string[]) T
WithIncludeArchiveFilenames<ExtractCommandBuilder>(string, string[]) T
WithIncludeFilenames<ExtractCommandBuilder>(RecurseType, string, string[]) T
fluent setter for ISupportSwitchIncludeFilenames.
WithIncludeFilenames<ExtractCommandBuilder>(string, string[]) T
fluent setter for ISupportSwitchIncludeFilenames.
WithNtSecurityInformation<ExtractCommandBuilder>() T
WithNtfsAlternateStreams<ExtractCommandBuilder>() T
WithOutputDirectory<ExtractCommandBuilder>(DirectoryPath) T
fluent setter for ISupportSwitchOutputDirectory.
WithOverwriteMode<ExtractCommandBuilder>(OverwriteMode) T
fluent setter for ISupportSwitchOverwriteMode.
WithPassword<ExtractCommandBuilder>(string) T
fluent setter for ISupportSwitchPassword.
WithRecurseSubdirectories<ExtractCommandBuilder>(RecurseType) T

See Also

GitHub Discussion