ListCommandBuilder Class

Summary

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

See Also