ISwitch Interface

Summary

Base for all Switches.
graph BT Type["ISwitch"] class Type type-node Implementing0["SwitchWorkingDirectory"]-.->Type click Implementing0 "/api/Cake.SevenZip.Switches/SwitchWorkingDirectory" Implementing1["SwitchOutputDirectory"]-.->Type click Implementing1 "/api/Cake.SevenZip.Switches/SwitchOutputDirectory" Implementing2["SwitchExcludeFilenameCollection"]-.->Type click Implementing2 "/api/Cake.SevenZip.Switches/SwitchExcludeFilenameCollection" Implementing3["SwitchPassword"]-.->Type click Implementing3 "/api/Cake.SevenZip.Switches/SwitchPassword" Implementing4["SwitchOverwriteMode"]-.->Type click Implementing4 "/api/Cake.SevenZip.Switches/SwitchOverwriteMode" Implementing5["SwitchCompressionMethod"]-.->Type click Implementing5 "/api/Cake.SevenZip.Switches/SwitchCompressionMethod" Implementing6["SwitchSetHashFunction"]-.->Type click Implementing6 "/api/Cake.SevenZip.Switches/SwitchSetHashFunction" Implementing7["SwitchDeleteAfterCompression"]-.->Type click Implementing7 "/api/Cake.SevenZip.Switches/SwitchDeleteAfterCompression" Implementing8["SwitchVolume"]-.->Type click Implementing8 "/api/Cake.SevenZip.Switches/SwitchVolume" Implementing9["SwitchArchiveType"]-.->Type click Implementing9 "/api/Cake.SevenZip.Switches/SwitchArchiveType" Implementing10["SwitchIncludeFilename"]-.->Type click Implementing10 "/api/Cake.SevenZip.Switches/SwitchIncludeFilename" Implementing11["SwitchVolumeCollection"]-.->Type click Implementing11 "/api/Cake.SevenZip.Switches/SwitchVolumeCollection" Implementing12["SwitchCompressFilesOpenForWriting"]-.->Type click Implementing12 "/api/Cake.SevenZip.Switches/SwitchCompressFilesOpenForWriting" Implementing13["SwitchNtSecurityInformation"]-.->Type click Implementing13 "/api/Cake.SevenZip.Switches/SwitchNtSecurityInformation" Implementing14["SwitchExcludeArchiveFilename"]-.->Type click Implementing14 "/api/Cake.SevenZip.Switches/SwitchExcludeArchiveFilename" Implementing15["SwitchDisableParsingOfArchiveName"]-.->Type click Implementing15 "/api/Cake.SevenZip.Switches/SwitchDisableParsingOfArchiveName" Implementing16["SwitchIncludeFilenameCollection"]-.->Type click Implementing16 "/api/Cake.SevenZip.Switches/SwitchIncludeFilenameCollection" Implementing17["SwitchSetTimestampFromMostRecentFile"]-.->Type click Implementing17 "/api/Cake.SevenZip.Switches/SwitchSetTimestampFromMostRecentFile" Implementing18["SwitchSetHashFunctionCollection"]-.->Type click Implementing18 "/api/Cake.SevenZip.Switches/SwitchSetHashFunctionCollection" Implementing19["SwitchSelfExtractingArchive"]-.->Type click Implementing19 "/api/Cake.SevenZip.Switches/SwitchSelfExtractingArchive" Implementing20["SwitchExcludeArchiveFilenameCollection"]-.->Type click Implementing20 "/api/Cake.SevenZip.Switches/SwitchExcludeArchiveFilenameCollection" Implementing21["SwitchExcludeFilename"]-.->Type click Implementing21 "/api/Cake.SevenZip.Switches/SwitchExcludeFilename" Implementing22["SwitchIncludeArchiveFilename"]-.->Type click Implementing22 "/api/Cake.SevenZip.Switches/SwitchIncludeArchiveFilename" Implementing23["BaseBoolSwitch"]-.->Type click Implementing23 "/api/Cake.SevenZip.Switches/BaseBoolSwitch" Implementing24["SwitchFullyQualifiedFilePaths"]-.->Type click Implementing24 "/api/Cake.SevenZip.Switches/SwitchFullyQualifiedFilePaths" Implementing25["BaseSwitchCollection<T>"]-.->Type click Implementing25 "/api/Cake.SevenZip.Switches/BaseSwitchCollection_1" Implementing26["SwitchNtfsAlternateStreams"]-.->Type click Implementing26 "/api/Cake.SevenZip.Switches/SwitchNtfsAlternateStreams" Implementing27["SwitchIncludeArchiveFilenameCollection"]-.->Type click Implementing27 "/api/Cake.SevenZip.Switches/SwitchIncludeArchiveFilenameCollection" Implementing28["SwitchShowTechnicalInformation"]-.->Type click Implementing28 "/api/Cake.SevenZip.Switches/SwitchShowTechnicalInformation" Implementing29["SwitchUpdateOptions"]-.->Type click Implementing29 "/api/Cake.SevenZip.Switches/SwitchUpdateOptions" Implementing30["SwitchRecurseSubdirectories"]-.->Type click Implementing30 "/api/Cake.SevenZip.Switches/SwitchRecurseSubdirectories"

Syntax

public interface ISwitch

Attributes

Type Description
NullableContextAttribute

Methods

Name Value Summary
BuildArguments(ProcessArgumentBuilder) void
Builds the arguments using the builder.

Extension Methods

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