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 all commands that have output. (E.g. InformationCommand).

Assembly

Cake.7zip.dll

Namespace

Cake.SevenZip.Commands

Interfaces

ICommand
ICanParseOutput

Base Types

Object
BaseCommand

Derived Types

graph BT Type-->Base0["BaseCommand"] click Base0 "/api/Cake.SevenZip.Commands/BaseCommand" Base0-->Base1["Object"] Type-.->Interface0["ICommand"] click Interface0 "/api/Cake.SevenZip.Commands/ICommand" Type-.->Interface1["ICanParseOutput"] Type["BaseOutputCommand<T>"] class Type type-node Derived0["HashCommand"]-->Type click Derived0 "/api/Cake.SevenZip.Commands/HashCommand" Derived1["TestCommand"]-->Type click Derived1 "/api/Cake.SevenZip.Commands/TestCommand" Derived2["BenchmarkCommand"]-->Type click Derived2 "/api/Cake.SevenZip.Commands/BenchmarkCommand" Derived3["InformationCommand"]-->Type click Derived3 "/api/Cake.SevenZip.Commands/InformationCommand" Derived4["ListCommand"]-->Type click Derived4 "/api/Cake.SevenZip.Commands/ListCommand"

Syntax

public abstract class BaseOutputCommand<T> : BaseCommand, ICommand, ICanParseOutput 
    where T : IOutput

Type Parameters

Name	Description
T	The type on the output.

Constructors

Name	Summary
BaseOutputCommand()

Properties

Name	Value	Summary
CommandChar	string	Gets the command character. (e.g. "a", "u" or "e"...) Inherited from BaseCommand
OutputAction	Action<T>	Gets or sets the output-action, to be called when output is available.
RawOutputAction	Action<string[]>	Gets or sets the raw output-action, to be called when output is available.
Switches	IEnumerable<ISwitch>	Gets all supported switches. Inherited from BaseCommand

Methods

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

Extension Methods

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