GemSettings Class

Summary

Contains the common settings used by all commands in Gem.
Assembly
Cake.Gem.dll
Namespace
Cake.Gem
Base Types
  • ToolSettings
Derived Types
graph BT Type-->Base0["ToolSettings"] Type["GemSettings"] class Type type-node Derived0["GemPushSettings"]-->Type click Derived0 "/api/Cake.Gem.Push/GemPushSettings" Derived1["GemBuildSettings"]-->Type click Derived1 "/api/Cake.Gem.Build/GemBuildSettings"

Syntax

public abstract class GemSettings : ToolSettings

Constructors

Name Summary
GemSettings()

Properties

Name Value Summary
Backtrace bool
Gets or sets a value indicating whether to show stack backtrace on errors.
ConfigFilePath FilePath
Gets or sets a value for the configuration file to use instead of default
Debug bool
Gets or sets a value indicating whether to turn on Ruby debugging.
Quiet bool
Gets or sets a value indicating whether to silence commands.
Verbose bool
Gets or sets a value indicating whether to use verbose level of output.

Extension Methods

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