TestCommand Class

Summary

Test one or more archives (Command: t).

The builder is TestCommandBuilder.

Assembly
Cake.7zip.dll
Namespace
Cake.SevenZip.Commands
Interfaces
Base Types
graph BT Type-->Base0["BaseOutputCommand<ITestOutput>"] 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["IHaveArgumentFiles"] click Interface3 "/api/Cake.SevenZip.Arguments/IHaveArgumentFiles" Type-.->Interface4["IHaveArgument"] click Interface4 "/api/Cake.SevenZip.Arguments/IHaveArgument" Type-.->Interface5["ISupportSwitchIncludeArchiveFilenames"] click Interface5 "/api/Cake.SevenZip.Switches/ISupportSwitchIncludeArchiveFilenames" Type-.->Interface6["ISupportSwitchExcludeArchiveFilenames"] click Interface6 "/api/Cake.SevenZip.Switches/ISupportSwitchExcludeArchiveFilenames" Type-.->Interface7["ISupportSwitchDisableParsingOfArchiveName"] click Interface7 "/api/Cake.SevenZip.Switches/ISupportSwitchDisableParsingOfArchiveName" Type-.->Interface8["ISupportSwitchIncludeFilenames"] click Interface8 "/api/Cake.SevenZip.Switches/ISupportSwitchIncludeFilenames" Type-.->Interface9["ISupportSwitchExcludeFilenames"] click Interface9 "/api/Cake.SevenZip.Switches/ISupportSwitchExcludeFilenames" Type-.->Interface10["ISupportSwitchPassword"] click Interface10 "/api/Cake.SevenZip.Switches/ISupportSwitchPassword" Type-.->Interface11["ISupportSwitchNtfsAlternateStreams"] click Interface11 "/api/Cake.SevenZip.Switches/ISupportSwitchNtfsAlternateStreams" Type-.->Interface12["ISupportSwitchRecurseSubdirectories"] click Interface12 "/api/Cake.SevenZip.Switches/ISupportSwitchRecurseSubdirectories" Type-.->Interface13["ISupportSwitch"] click Interface13 "/api/Cake.SevenZip.Switches/ISupportSwitch" Type["TestCommand"] class Type type-node

Syntax

public sealed class TestCommand : BaseOutputCommand<ITestOutput>, ICommand, ICanParseOutput, 
    IHaveArgumentArchive, IHaveArgumentFiles, IHaveArgument, ISupportSwitchIncludeArchiveFilenames, 
    ISupportSwitchExcludeArchiveFilenames, ISupportSwitchDisableParsingOfArchiveName, 
    ISupportSwitchIncludeFilenames, ISupportSwitchExcludeFilenames, ISupportSwitchPassword, 
    ISupportSwitchNtfsAlternateStreams, ISupportSwitchRecurseSubdirectories, ISupportSwitch

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

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

Properties

Name Value Summary
Archive FilePath
Sets the archive the command operates on.
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.
Files FilePathCollection
Gets or sets the list of files this command operates on. These are single files. (I.e. to add to, or to remove from the archive).

For add and update, single files from the file-system will always be placed directly into the archive without any directory-structure.

Setting Files like this in add/update: 
Files = new[] {
  new FilePath("C:\\some\\place\\a.txt"),
  new FilePath("C:\\some\\other\\place\\b.txt"),
  new FilePath("C:\\a\\totally\\different\\place\\c.txt")
};
Will result in an archive: 
Archive.zip
- a.txt
- b.txt
- c.txt
without any directory structure.
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.
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<TestCommand>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TestCommand>(TestCommand[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TestCommand>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TestCommand>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TestCommand>(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
ThrowIfNull<TestCommand>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin