ListCommand Class

Summary

Show List about supported formats (Command: i).

The builder is ListCommandBuilder.

graph BT Type-->Base0["BaseOutputCommand<IListOutput>"] Base0-->Base1["BaseCommand"] click Base1 "/api/Cake.SevenZip.Commands/BaseCommand" Base1-->Base2["Object"] Type-.->Interface0["ICommand"] click Interface0 "/api/Cake.SevenZip.Commands/ICommand" Type-.->Interface1["ICanParseOutput"] Type-.->Interface2["IHaveArgumentArchive"] click Interface2 "/api/Cake.SevenZip.Arguments/IHaveArgumentArchive" Type-.->Interface3["IHaveArgument"] click Interface3 "/api/Cake.SevenZip.Arguments/IHaveArgument" Type-.->Interface4["ISupportSwitchIncludeArchiveFilenames"] click Interface4 "/api/Cake.SevenZip.Switches/ISupportSwitchIncludeArchiveFilenames" Type-.->Interface5["ISupportSwitchDisableParsingOfArchiveName"] click Interface5 "/api/Cake.SevenZip.Switches/ISupportSwitchDisableParsingOfArchiveName" Type-.->Interface6["ISupportSwitchExcludeArchiveFilenames"] click Interface6 "/api/Cake.SevenZip.Switches/ISupportSwitchExcludeArchiveFilenames" Type-.->Interface7["ISupportSwitchIncludeFilenames"] click Interface7 "/api/Cake.SevenZip.Switches/ISupportSwitchIncludeFilenames" Type-.->Interface8["ISupportSwitchNtfsAlternateStreams"] click Interface8 "/api/Cake.SevenZip.Switches/ISupportSwitchNtfsAlternateStreams" Type-.->Interface9["ISupportSwitchPassword"] click Interface9 "/api/Cake.SevenZip.Switches/ISupportSwitchPassword" Type-.->Interface10["ISupportSwitchRecurseSubdirectories"] click Interface10 "/api/Cake.SevenZip.Switches/ISupportSwitchRecurseSubdirectories" Type-.->Interface11["ISupportSwitchArchiveType"] click Interface11 "/api/Cake.SevenZip.Switches/ISupportSwitchArchiveType" Type-.->Interface12["ISupportSwitchExcludeFilenames"] click Interface12 "/api/Cake.SevenZip.Switches/ISupportSwitchExcludeFilenames" Type-.->Interface13["ISupportSwitchShowTechnicalInformation"] click Interface13 "/api/Cake.SevenZip.Switches/ISupportSwitchShowTechnicalInformation" Type-.->Interface14["ISupportSwitch"] click Interface14 "/api/Cake.SevenZip.Switches/ISupportSwitch" Type["ListCommand"] class Type type-node

Syntax

public sealed class ListCommand : BaseOutputCommand<IListOutput>, ICommand, ICanParseOutput, 
    IHaveArgumentArchive, IHaveArgument, ISupportSwitchIncludeArchiveFilenames, 
    ISupportSwitchDisableParsingOfArchiveName, ISupportSwitchExcludeArchiveFilenames, 
    ISupportSwitchIncludeFilenames, ISupportSwitchNtfsAlternateStreams, ISupportSwitchPassword, 
    ISupportSwitchRecurseSubdirectories, ISupportSwitchArchiveType, ISupportSwitchExcludeFilenames, 
    ISupportSwitchShowTechnicalInformation, ISupportSwitch

Constructors

Name Summary
ListCommand() Initializes a new instance of the ListCommand class.

Properties

Name Value Summary
Archive FilePath
Sets the archive the command operates on.
ArchiveType SwitchArchiveType
Gets or sets the SwitchArchiveType.
CommandChar string
Gets the command character. (e.g. "a", "u" or "e"...)
DisableParsingOfArchiveName SwitchDisableParsingOfArchiveName
Gets or sets the SwitchDisableParsingOfArchiveName.
ExcludeArchiveFilenames SwitchExcludeArchiveFilenameCollection
Gets or sets the SwitchExcludeArchiveFilenameCollection.
ExcludeFilenames SwitchExcludeFilenameCollection
Gets or sets the SwitchExcludeFilenameCollection.
IncludeArchiveFilenames SwitchIncludeArchiveFilenameCollection
Gets or sets the SwitchIncludeArchiveFilenameCollection.
IncludeFilenames SwitchIncludeFilenameCollection
Gets or sets the SwitchIncludeFilenameCollection.
NtfsAlternateStreams SwitchNtfsAlternateStreams
Gets or sets the SwitchNtfsAlternateStreams.
Password SwitchPassword
Gets or sets the SwitchPassword.
RecurseSubdirectories SwitchRecurseSubdirectories
Gets or sets the SwitchRecurseSubdirectories.
ShowTechnicalInformation SwitchShowTechnicalInformation
Gets or sets the SwitchDeleteAfterCompression.
Switches IEnumerable<ISwitch>
Gets all supported switches.

Methods

Name Value Summary
BuildArgumentParams(ProcessArgumentBuilder) void
adds only the arguments to the builder. (i.e. Archive, files, directories).
BuildArguments(ProcessArgumentBuilder) void
Builds the arguments.
Inherited from BaseCommand

Extension Methods

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