ProcessArgumentBuilder Class

Summary

Utility for building process arguments.
Namespace
Cake.Core.IO
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IReadOnlyCollection<IProcessArgument>"] Type-.->Interface1["IEnumerable<IProcessArgument>"] Type-.->Interface2["IEnumerable"] Type["ProcessArgumentBuilder"] class Type type-node

Syntax

public sealed class ProcessArgumentBuilder : IReadOnlyCollection<IProcessArgument>, 
    IEnumerable<IProcessArgument>, IEnumerable

Constructors

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

Properties

Name Value Summary
Count int
Gets the number of arguments contained in the ProcessArgumentBuilder.

Methods

Name Value Summary
Append(IProcessArgument) void
Appends an argument.
AppendRange(IEnumerable<IProcessArgument>) void
Appends arguments.
Clear() void
Clears all arguments from the builder.
FilterUnsafe(string) string
Tries to filer any unsafe arguments from string.
FromString(string) ProcessArgumentBuilder
Performs a conversion from string to ProcessArgumentBuilder.
static
FromStringQuoted(string) ProcessArgumentBuilder
Performs a conversion from string to ProcessArgumentBuilder.
static
FromStrings(IEnumerable<string>) ProcessArgumentBuilder
Performs a conversion from IEnumerable<T> to ProcessArgumentBuilder.
static
FromStringsQuoted(IEnumerable<string>) ProcessArgumentBuilder
Performs a conversion from IEnumerable<T> to ProcessArgumentBuilder.
static
Prepend(IProcessArgument) void
Prepends an argument.
PrependRange(IEnumerable<IProcessArgument>) void
Prepends arguments.
Render() string
Renders the arguments as a string. Sensitive information will be included.
RenderSafe() string
Renders the arguments as a string. Sensitive information will be redacted.

Operators

Name Value Summary
implicit operator ProcessArgumentBuilder(string) ProcessArgumentBuilder

Extension Methods

Name Value Summary
Append(string, object[]) ProcessArgumentBuilder
Formats and appends the specified text to the argument builder.
Append(string) ProcessArgumentBuilder
Appends the specified text to the argument builder.
AppendMSBuildSettings(DotNetMSBuildSettings, ICakeEnvironment, bool) void
Adds MSBuild arguments.
AppendMSBuildSettings(DotNetMSBuildSettings, ICakeEnvironment) void
Adds MSBuild arguments.
AppendQuoted(IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified argument to the argument builder.
AppendQuoted(string, object[]) ProcessArgumentBuilder
Formats, quotes and appends the specified text to the argument builder.
AppendQuoted(string) ProcessArgumentBuilder
Quotes and appends the specified text to the argument builder.
AppendQuotedSecret(IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendQuotedSecret(string, IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendQuotedSecret(string, object[]) ProcessArgumentBuilder
Formats, quotes and appends the specified secret text to the argument builder.
AppendQuotedSecret(string, string, IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendQuotedSecret(string) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendSecret(IProcessArgument) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
AppendSecret(string, object[]) ProcessArgumentBuilder
Formats and appends the specified secret text to the argument builder.
AppendSecret(string) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
AppendSwitch(string, string, string) ProcessArgumentBuilder
Appends the specified switch to the argument builder.
AppendSwitch(string, string) ProcessArgumentBuilder
Appends the specified switch to the argument builder.
AppendSwitchQuoted(string, IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified argument to the argument builder.
AppendSwitchQuoted(string, string, IProcessArgument) ProcessArgumentBuilder
Quotes and appends the specified argument to the argument builder.
AppendSwitchQuoted(string, string, string) ProcessArgumentBuilder
Quotes and appends the specified text to the argument builder.
AppendSwitchQuoted(string, string) ProcessArgumentBuilder
Quotes and appends the specified text to the argument builder.
AppendSwitchQuotedSecret(string, string, string) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendSwitchQuotedSecret(string, string) ProcessArgumentBuilder
Quotes and appends the specified secret text to the argument builder.
AppendSwitchSecret(string, IProcessArgument) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
AppendSwitchSecret(string, string, IProcessArgument) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
AppendSwitchSecret(string, string, string) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
AppendSwitchSecret(string, string) ProcessArgumentBuilder
Appends the specified secret text to the argument builder.
CopyTo(ProcessArgumentBuilder) void
Copies all the arguments of the source ProcessArgumentBuilder to target ProcessArgumentBuilder.
Dump<ProcessArgumentBuilder>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ProcessArgumentBuilder>(ProcessArgumentBuilder[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
IsNullOrEmpty() bool
Indicates whether a ProcessArgumentBuilder is null or renders empty.
NotNull<ProcessArgumentBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<ProcessArgumentBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
Prepend(string, object[]) ProcessArgumentBuilder
Formats and prepends the specified text to the argument builder.
Prepend(string) ProcessArgumentBuilder
Prepend the specified text to the argument builder.
PrependQuoted(IProcessArgument) ProcessArgumentBuilder
Quotes and prepends the specified argument to the argument builder.
PrependQuoted(string, object[]) ProcessArgumentBuilder
Formats, quotes and prepends the specified text to the argument builder.
PrependQuoted(string) ProcessArgumentBuilder
Quotes and prepends the specified text to the argument builder.
PrependQuotedSecret(IProcessArgument) ProcessArgumentBuilder
Quotes and prepends the specified secret text to the argument builder.
PrependQuotedSecret(string, IProcessArgument) ProcessArgumentBuilder
Quotes and prepends the specified secret text to the argument builder.
PrependQuotedSecret(string, object[]) ProcessArgumentBuilder
Formats, quotes and prepends the specified secret text to the argument builder.
PrependQuotedSecret(string, string, IProcessArgument) ProcessArgumentBuilder
Quotes and prepend the specified secret text to the argument builder.
PrependQuotedSecret(string) ProcessArgumentBuilder
Quotes and prepends the specified secret text to the argument builder.
PrependSecret(IProcessArgument) ProcessArgumentBuilder
Prepend the specified secret text to the argument builder.
PrependSecret(string, object[]) ProcessArgumentBuilder
Formats and prepend the specified secret text to the argument builder.
PrependSecret(string) ProcessArgumentBuilder
Prepends the specified secret text to the argument builder.
PrependSwitch(string, string, string) ProcessArgumentBuilder
Prepend the specified switch to the argument builder.
PrependSwitch(string, string) ProcessArgumentBuilder
Prepend the specified switch to the argument builder.
PrependSwitchQuoted(string, IProcessArgument) ProcessArgumentBuilder
Quotes and prepends the specified argument to the argument builder.
PrependSwitchQuoted(string, string, IProcessArgument) ProcessArgumentBuilder
Quotes and prepends the specified argument to the argument builder.
PrependSwitchQuoted(string, string, string) ProcessArgumentBuilder
Quotes and prepends the specified text to the argument builder.
PrependSwitchQuoted(string, string) ProcessArgumentBuilder
Quotes and prepends the specified text to the argument builder.
PrependSwitchQuotedSecret(string, string, string) ProcessArgumentBuilder
Quotes and prepends the specified secret text to the argument builder.
PrependSwitchQuotedSecret(string, string) ProcessArgumentBuilder
Quotes and prepend the specified secret text to the argument builder.
PrependSwitchSecret(string, IProcessArgument) ProcessArgumentBuilder
Prepend the specified secret text to the argument builder.
PrependSwitchSecret(string, string, IProcessArgument) ProcessArgumentBuilder
Prepend the specified secret text to the argument builder.
PrependSwitchSecret(string, string, string) ProcessArgumentBuilder
Prepend the specified secret text to the argument builder.
PrependSwitchSecret(string, string) ProcessArgumentBuilder
Prepend the specified secret text to the argument builder.
ThrowIfNull<ProcessArgumentBuilder>(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<ProcessArgumentBuilder>(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