ListCommandBuilder Class

Summary

Builder for ListCommand.
Namespace
Cake.SevenZip.Builder
Interfaces
Base Types
graph BT Type-->Base0["BaseOutputBuilder<ListCommandBuilder, IListOutput>"] Base0-->Base1["object"] Type-.->Interface0["ISupportArgumentBuilder<IHaveArgumentArchive>"] Type-.->Interface1["ISupportSwitchBuilder<ISupportSwitchIncludeArchiveFilenames>"] Type-.->Interface2["ISupportSwitchBuilder<ISupportSwitchDisableParsingOfArchiveName>"] Type-.->Interface3["ISupportSwitchBuilder<ISupportSwitchExcludeArchiveFilenames>"] Type-.->Interface4["ISupportSwitchBuilder<ISupportSwitchIncludeFilenames>"] Type-.->Interface5["ISupportSwitchBuilder<ISupportSwitchNtfsAlternateStreams>"] Type-.->Interface6["ISupportSwitchBuilder<ISupportSwitchPassword>"] Type-.->Interface7["ISupportSwitchBuilder<ISupportSwitchRecurseSubdirectories>"] Type-.->Interface8["ISupportSwitchBuilder<ISupportSwitchArchiveType>"] Type-.->Interface9["ISupportSwitchBuilder<ISupportSwitchExcludeFilenames>"] Type-.->Interface10["ISupportSwitchBuilder<ISupportSwitchShowTechnicalInformation>"] Type["ListCommandBuilder"] class Type type-node

Syntax

public sealed class ListCommandBuilder : BaseOutputBuilder<ListCommandBuilder, IListOutput>, 
    ISupportArgumentBuilder<IHaveArgumentArchive>, 
    ISupportSwitchBuilder<ISupportSwitchIncludeArchiveFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchDisableParsingOfArchiveName>, 
    ISupportSwitchBuilder<ISupportSwitchExcludeArchiveFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchIncludeFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchNtfsAlternateStreams>, 
    ISupportSwitchBuilder<ISupportSwitchPassword>, 
    ISupportSwitchBuilder<ISupportSwitchRecurseSubdirectories>, 
    ISupportSwitchBuilder<ISupportSwitchArchiveType>, 
    ISupportSwitchBuilder<ISupportSwitchExcludeFilenames>, 
    ISupportSwitchBuilder<ISupportSwitchShowTechnicalInformation>

Examples

Task("ListArchiveContent")
    .Does(() =>
{
    SevenZip(m => m
        .InListMode()
        .WithArchive(File("path/to/file.zip"))
        .WithCommandOutput(o =>
        {
            Information("7Zip version is:" + o.Information);
            var archive = o.Archives.Single(); // only one archive given above
            foreach(var file in archive.Files)
            {
                Information($"{file.Name} has compressed size {file.CompressedSize} (of {file.Size})");
            }
        });
});

Properties

Name Value Summary
OutputCommand BaseOutputCommand<IListOutput>
Gets the output command.

Extension Methods

Name Value Summary
WithArchive<ListCommandBuilder>(FilePath) T
fluent setter for Archive.
WithArchiveType<ListCommandBuilder>(SwitchArchiveType) T
fluent setter for ISupportSwitchArchiveType.
WithDisableParsingOfArchiveName<ListCommandBuilder>() T
WithExcludeArchiveFilenames<ListCommandBuilder>(RecurseType, string, string[]) T
WithExcludeArchiveFilenames<ListCommandBuilder>(string, string[]) T
WithExcludeFilenames<ListCommandBuilder>(RecurseType, string, string[]) T
fluent setter for ISupportSwitchExcludeFilenames.
WithExcludeFilenames<ListCommandBuilder>(string, string[]) T
fluent setter for ISupportSwitchExcludeFilenames.
WithIncludeArchiveFilenames<ListCommandBuilder>(RecurseType, string, string[]) T
WithIncludeArchiveFilenames<ListCommandBuilder>(string, string[]) T
WithIncludeFilenames<ListCommandBuilder>(RecurseType, string, string[]) T
fluent setter for ISupportSwitchIncludeFilenames.
WithIncludeFilenames<ListCommandBuilder>(string, string[]) T
fluent setter for ISupportSwitchIncludeFilenames.
WithNtfsAlternateStreams<ListCommandBuilder>() T
WithPassword<ListCommandBuilder>(string) T
fluent setter for ISupportSwitchPassword.
WithRecurseSubdirectories<ListCommandBuilder>(RecurseType) T
WithShowTechnicalInformation<ListCommandBuilder>() T

See Also

GitHub Discussion