org.springframework.boot.gradle.tasks.run

Class BootRun

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.springframework.boot.gradle.tasks.run.BootRun

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>

public class BootRun
extends DefaultTask

Custom JavaExec task for running a Spring Boot application.

Since:

2.0.0

Author:

Andy Wilkinson

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
BootRun()

Method Summary

Modifier and Type	Method and Description
void	classpath(Object... entries) Adds the given entries to the classpath used to run the application.
void	execSpec(Action<JavaExecSpec> execSpecConfigurer) Registers the given execSpecConfigurer to be called to customize the JavaExecSpec prior to running the application.
List<String>	getArgs() Returns the arguments to be used to run the application.
FileCollection	getClasspath()
List<String>	getJvmArgs() Returns the JVM arguments to be used to run the application.
String	getMain() Returns the name of the main class to be run.
void	run()
void	setArgs(List<String> args) Configures the application to be run using the given args.
void	setArgs(Provider<List<String>> argsProvider) Configures the application to be run using the args provided by the given argsProvider.
void	setJvmArgs(List<String> jvmArgs) Configures the application to be run using the given jvmArgs.
void	setJvmArgs(Provider<List<String>> jvmArgsProvider) Configures the application to be run using the JVM args provided by the given jvmArgsProvider.
void	setMain(Provider<String> mainProvider) Sets the main class to be executed using the given mainProvider.
void	setMain(String main) Sets the main class to be run.
void	sourceResources(SourceSet sourceSet) Adds the source directories of the given sourceSet's resources to the start of the classpath in place of the output's resources directory.

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BootRun

public BootRun()

Method Detail

classpath

public void classpath(Object... entries)

Adds the given entries to the classpath used to run the application.

Parameters:

entries - the classpath entries

getClasspath

@InputFiles
public FileCollection getClasspath()

sourceResources

public void sourceResources(SourceSet sourceSet)

Adds the source directories of the given sourceSet's resources to the start of the classpath in place of the output's resources directory.

Parameters:

sourceSet - the source set

getMain

public String getMain()

Returns the name of the main class to be run.

Returns:

the main class name or null

setMain

public void setMain(Provider<String> mainProvider)

Sets the main class to be executed using the given mainProvider.

Parameters:

mainProvider - provider of the main class name

setMain

public void setMain(String main)

Sets the main class to be run.

Parameters:

main - the main class name

getJvmArgs

public List<String> getJvmArgs()

Returns the JVM arguments to be used to run the application.

Returns:

the JVM arguments or null

setJvmArgs

public void setJvmArgs(Provider<List<String>> jvmArgsProvider)

Configures the application to be run using the JVM args provided by the given jvmArgsProvider.

Parameters:

jvmArgsProvider - the provider of the JVM args

setJvmArgs

public void setJvmArgs(List<String> jvmArgs)

Configures the application to be run using the given jvmArgs.

Parameters:

jvmArgs - the JVM args

getArgs

public List<String> getArgs()

Returns the arguments to be used to run the application.

Returns:

the arguments or null

setArgs

public void setArgs(List<String> args)

Configures the application to be run using the given args.

Parameters:

args - the args

setArgs

public void setArgs(Provider<List<String>> argsProvider)

Configures the application to be run using the args provided by the given argsProvider.

Parameters:

argsProvider - the provider of the args

execSpec

public void execSpec(Action<JavaExecSpec> execSpecConfigurer)

Registers the given execSpecConfigurer to be called to customize the JavaExecSpec prior to running the application.

Parameters:

execSpecConfigurer - the configurer

run

public void run()