SvnTool<TSettings> Class

Summary

Base class for all Subversion operations.
graph BT Type-->Base0["Object"] Type["SvnTool<TSettings>"] class Type type-node Derived0["SvnCleaner"]-->Type click Derived0 "/api/Cake.Svn.CleanUp/SvnCleaner" Derived1["SvnCheckouter"]-->Type click Derived1 "/api/Cake.Svn.Checkout/SvnCheckouter" Derived2["SvnUpdater"]-->Type click Derived2 "/api/Cake.Svn.Update/SvnUpdater" Derived3["SvnDeleter"]-->Type click Derived3 "/api/Cake.Svn.Delete/SvnDeleter" Derived4["SvnInfo"]-->Type click Derived4 "/api/Cake.Svn.Info/SvnInfo" Derived5["SvnAdder"]-->Type click Derived5 "/api/Cake.Svn.Add/SvnAdder" Derived6["SvnVacuum"]-->Type click Derived6 "/api/Cake.Svn.Vacuum/SvnVacuum" Derived7["SvnExporter"]-->Type click Derived7 "/api/Cake.Svn.Export/SvnExporter" Derived8["SvnStatusTool"]-->Type click Derived8 "/api/Cake.Svn.Status/SvnStatusTool"

Syntax

public abstract class SvnTool<TSettings> where TSettings : SvnSettings

Type Parameters

Name Description
TSettings Type of the settings class.

Constructors

Name Summary
SvnTool(Func<ISvnClient>) Initializes a new instance of the SvnTool<TSettings> class.

Methods

Name Value Summary
CheckSettingsIsNotNull(SvnRemoteSettings) void
Checks the setting parameter is not null and throws an exception if it is.
GetClient() ISvnClient
Returns a new instance of a Subversion client.

Extension Methods

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