AppPackagerTool<TSettings> Class

Summary

Base class for all App Packager related tools.
Assembly
Cake.AppPackager.dll
Namespace
Cake.AppPackager
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["AppPackagerTool<TSettings>"] class Type type-node Derived0["AppUnpacker"]-->Type click Derived0 "/api/Cake.AppPackager.Unpack/AppUnpacker" Derived1["AppPacker"]-->Type click Derived1 "/api/Cake.AppPackager.Pack/AppPacker" Derived2["AppUnbundler"]-->Type click Derived2 "/api/Cake.AppPackager.Unbundle/AppUnbundler" Derived3["AppDecrypter"]-->Type click Derived3 "/api/Cake.AppPackager.Decrypt/AppDecrypter" Derived4["AppEncrypter"]-->Type click Derived4 "/api/Cake.AppPackager.Encrypt/AppEncrypter" Derived5["AppBundler"]-->Type click Derived5 "/api/Cake.AppPackager.Bundle/AppBundler"

Syntax

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

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Methods

Name Value Summary
GetAlternativeToolPaths(TSettings) IEnumerable<FilePath>
Gets alternative file paths which the tool may exist in
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<AppPackagerTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppPackagerTool<TSettings>>(AppPackagerTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppPackagerTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<AppPackagerTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<AppPackagerTool<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<AppPackagerTool<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