StringLiteralArgument Class

Summary

Represents a string-literal argument. Specifically, '$' chars will not be evaulated as variables, nor will '()' pairs as expressions.
Assembly
Cake.Powershell.dll
Namespace
Cake.Powershell
Interfaces
  • IProcessArgument
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IProcessArgument"] Type["StringLiteralArgument"] class Type type-node

Syntax

public sealed class StringLiteralArgument : IProcessArgument

Constructors

Name Summary
StringLiteralArgument(IProcessArgument) Initializes an instance of the StringLiteralArgument class.

Methods

Name Value Summary
Render() string
Renders the argument as a string-literal string.
RenderSafe() string
Renders the argument as a string-literal string. Sensitive information will be redacted.
ToString() string
Returns a string that represents this instance.

Extension Methods

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