GradleRunner Class

Summary

A wrapper around Gradle functionality within a Cake build script.
Assembly
Cake.Gradle.dll
Namespace
Cake.Gradle
Base Types
graph BT Type-->Base0["Tool<GradleRunnerSettings>"] Type["GradleRunner"] class Type type-node

Syntax

public class GradleRunner : Tool<GradleRunnerSettings>

Constructors

Methods

Name Value Summary
FromPath(DirectoryPath) GradleRunner
Specifies the path the Gradle project resides in.
GetAlternativeToolPaths(GradleRunnerSettings) IEnumerable<FilePath>
Gets the paths to the Gradle wrapper, if available.
GetToolExecutableNames() IEnumerable<string>
Gets the name of the tool executable, prefers wrapper over plain Gradle.
GetToolName() string
Gets this tools name.
GetWorkingDirectory(GradleRunnerSettings) DirectoryPath
Gets the working directory. Uses the directory specified with 'FromPath()'. Otherwise defaults to the currently set working directory.
Run() void
Starts the Gradle run.
WithArguments(string[]) GradleRunner
Specifies arguments to be passed to the Gradle executable.
WithLogLevel(GradleLogLevel) GradleRunner
Sets the gradle logging level.
WithProjectProperty(string, string, bool) GradleRunner
Adds a project property to the arguments.
WithSystemProperty(string, string, bool) GradleRunner
Adds a system-property to the arguments.
WithTask(string) GradleRunner
Specifies a Gradle task to be run.
WithTask(string[]) GradleRunner
Specifies Gradle tasks to be run.

Extension Methods

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