This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.7zip.

Summary

Base for switches that can be given multiple times. An example is ISupportSwitchExcludeFilenames (-x!*.pdf -x!*.xml) which uses SwitchExcludeFilenameCollection (which implements this BaseCollection) to set multiple SwitchExcludeFilename.

Assembly

Cake.7zip.dll

Namespace

Cake.SevenZip.Switches

Interfaces

ISwitch

Base Types

Object

Derived Types

graph BT Type-->Base0["Object"] Type-.->Interface0["ISwitch"] click Interface0 "/api/Cake.SevenZip.Switches/ISwitch" Type["BaseSwitchCollection<T>"] class Type type-node Derived0["SwitchVolumeCollection"]-->Type click Derived0 "/api/Cake.SevenZip.Switches/SwitchVolumeCollection" Derived1["SwitchExcludeFilenameCollection"]-->Type click Derived1 "/api/Cake.SevenZip.Switches/SwitchExcludeFilenameCollection" Derived2["SwitchExcludeArchiveFilenameCollection"]-->Type click Derived2 "/api/Cake.SevenZip.Switches/SwitchExcludeArchiveFilenameCollection" Derived3["SwitchIncludeArchiveFilenameCollection"]-->Type click Derived3 "/api/Cake.SevenZip.Switches/SwitchIncludeArchiveFilenameCollection" Derived4["SwitchIncludeFilenameCollection"]-->Type click Derived4 "/api/Cake.SevenZip.Switches/SwitchIncludeFilenameCollection" Derived5["SwitchSetHashFunctionCollection"]-->Type click Derived5 "/api/Cake.SevenZip.Switches/SwitchSetHashFunctionCollection"

Syntax

public abstract class BaseSwitchCollection<T> : ISwitch where T : ISwitch

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Type Parameters

Name	Description
T	The Switch-Type.

Constructors

Name	Summary
BaseSwitchCollection()	Initializes a new instance of the `BaseSwitchCollection<T>` class.

Properties

Name	Value	Summary
Switches	List<T>	Gets the switches.

Methods

Name	Value	Summary
Add(T)	void	Adds the specified switch.
BuildArguments(ProcessArgumentBuilder)	void	Builds the arguments using the builder.

Extension Methods

Name	Value	Summary
Dump<BaseSwitchCollection<T>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<BaseSwitchCollection<T>>(BaseSwitchCollection<T>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<BaseSwitchCollection<T>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<BaseSwitchCollection<T>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<BaseSwitchCollection<T>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<BaseSwitchCollection<T>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

BaseSwitchCollection<T> Class