DockerComposeTool<TSettings> Class

Summary

Base class for all Docker related tools.
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["DockerComposeTool<TSettings>"] class Type type-node Derived0["GenericDockerComposeRunner<TSettings>"]-->Type click Derived0 "/api/Cake.Docker/GenericDockerComposeRunner_1"

Syntax

public abstract class DockerComposeTool<TSettings> : Tool<TSettings> where TSettings : ToolSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
DockerComposeTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the DockerTool<TSettings> class.

Methods

Name Value Summary
GetAlternativeToolPaths(TSettings) IEnumerable<FilePath>
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

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