org.springframework.boot.gradle.dsl

Class SpringBootExtension

java.lang.Object

org.springframework.boot.gradle.dsl.SpringBootExtension

public class SpringBootExtension
extends java.lang.Object

Entry point to Spring Boot's Gradle DSL.

Since:

2.0.0

Author:

Andy Wilkinson, Scott Frederick

Constructor Summary

Constructors

Constructor and Description
SpringBootExtension(org.gradle.api.Project project) Creates a new SpringBootPluginExtension that is associated with the given project.

Method Summary

Modifier and Type	Method and Description
void	buildInfo() Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it.
void	buildInfo(org.gradle.api.Action<BuildInfo> configurer) Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it.
org.gradle.api.provider.Property<java.lang.String>	getMainClass() Returns the fully-qualified name of the application's main class.
java.lang.String	getMainClassName() Deprecated. since 2.4.0 for removal in 2.6.0 in favor of getMainClass().
void	setMainClassName(java.lang.String mainClassName) Deprecated. since 2.4.0 for removal in 2.6.0 in favor of getMainClass() and Property.set(Object)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringBootExtension

public SpringBootExtension(org.gradle.api.Project project)

Creates a new SpringBootPluginExtension that is associated with the given project.

Parameters:

project - the project

Method Detail

getMainClass

public org.gradle.api.provider.Property<java.lang.String> getMainClass()

Returns the fully-qualified name of the application's main class.

Returns:

the fully-qualified name of the application's main class

Since:

2.4.0

getMainClassName

@Deprecated
 @ReplacedBy(value="mainClass")
public java.lang.String getMainClassName()

Deprecated. since 2.4.0 for removal in 2.6.0 in favor of getMainClass().

Returns the fully-qualified main class name of the application.

Returns:

the fully-qualified name of the application's main class

setMainClassName

@Deprecated
public void setMainClassName(java.lang.String mainClassName)

Deprecated. since 2.4.0 for removal in 2.6.0 in favor of getMainClass() and Property.set(Object)

Sets the fully-qualified main class name of the application.

Parameters:

mainClassName - the fully-qualified name of the application's main class

buildInfo

public void buildInfo()

Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it.

By default, the task's destination dir will be a directory named META-INF beneath the main source set's resources output directory, and the task's project artifact will be the base name of the bootWar or bootJar task.

buildInfo

public void buildInfo(org.gradle.api.Action<BuildInfo> configurer)

Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it. The task is passed to the given configurer for further configuration.

By default, the task's destination dir will be a directory named META-INF beneath the main source set's resources output directory, and the task's project artifact will be the base name of the bootWar or bootJar task.

Parameters:

configurer - the task configurer