Skip navigation links
A B C E G H I L O P R S V Z 

A

apply(Project) - Method in class org.springframework.boot.gradle.plugin.SpringBootPlugin
 

B

BOOT_ARCHIVES_CONFIGURATION_NAME - Static variable in class org.springframework.boot.gradle.plugin.SpringBootPlugin
The name of the Configuration that contains Spring Boot archives.
BOOT_JAR_TASK_NAME - Static variable in class org.springframework.boot.gradle.plugin.SpringBootPlugin
The name of the default BootJar task.
BOOT_WAR_TASK_NAME - Static variable in class org.springframework.boot.gradle.plugin.SpringBootPlugin
The name of the default BootWar task.
BootArchive - Interface in org.springframework.boot.gradle.tasks.bundling
A Spring Boot "fat" archive task.
BootJar - Class in org.springframework.boot.gradle.tasks.bundling
A custom Jar task that produces a Spring Boot executable jar.
BootJar() - Constructor for class org.springframework.boot.gradle.tasks.bundling.BootJar
Creates a new BootJar task.
BootRun - Class in org.springframework.boot.gradle.tasks.run
Custom JavaExec task for running a Spring Boot application.
BootRun() - Constructor for class org.springframework.boot.gradle.tasks.run.BootRun
 
BootWar - Class in org.springframework.boot.gradle.tasks.bundling
A custom War task that produces a Spring Boot executable war.
BootWar() - Constructor for class org.springframework.boot.gradle.tasks.bundling.BootWar
Creates a new BootWar task.
buildInfo() - Method in class org.springframework.boot.gradle.dsl.SpringBootExtension
Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it.
buildInfo(Action<BuildInfo>) - Method in class org.springframework.boot.gradle.dsl.SpringBootExtension
Creates a new BuildInfo task named bootBuildInfo and configures the Java plugin's classes task to depend upon it.
BuildInfo - Class in org.springframework.boot.gradle.tasks.buildinfo
Task for generating a build-info.properties file from a Project.
BuildInfo() - Constructor for class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
 
BuildInfoProperties - Class in org.springframework.boot.gradle.tasks.buildinfo
The properties that are written into the build-info.properties file.

C

classpath(Object...) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Adds files to the classpath to include in the archive.
classpath(Object...) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
classpath(Object...) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Adds the given entries to the classpath used to run the application.
copy() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
copy() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
CreateBootStartScripts - Class in org.springframework.boot.gradle.tasks.application
Customization of CreateStartScripts that makes the main class name optional.
CreateBootStartScripts() - Constructor for class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
createCopyAction() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
createCopyAction() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 

E

equals(Object) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
 
equals(Object) - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
 
execSpec(Action<JavaExecSpec>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Registers the given execSpecConfigurer to be called to customize the JavaExecSpec prior to running the application.

G

generateBuildProperties() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Generates the build-info.properties file in the configured destination.
getAdditional() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Returns the additional properties that will be included.
getApplicationName() - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
getArgs() - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Returns the arguments to be used to run the application.
getArtifact() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Returns the value used for the build.artifact property.
getClasspath() - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Returns the classpath that will be included in the archive.
getClasspath() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
getClasspath() - Method in class org.springframework.boot.gradle.tasks.run.BootRun
 
getDestinationDir() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Returns the directory to which the build-info.properties file will be written.
getGroup() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Returns the value used for the build.group property.
getJvmArgs() - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Returns the JVM arguments to be used to run the application.
getLaunchScript() - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Returns the LaunchScriptConfiguration that will control the script that is prepended to the archive.
getLaunchScript() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
getLaunchScript() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
getMain() - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Returns the name of the main class to be run.
getMainClass() - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Returns the main class of the application.
getMainClass() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
getMainClass() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
getMainClassName() - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
getName() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Returns the value used for the build.name property.
getOutputDir() - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
getProperties() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Returns the properties that will be included in the build-info.properties file.
getProperties() - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
Returns the properties that are applied to the launch script when it's being including in the executable archive.
getProvidedClasspath() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
Returns the provided classpath, the contents of which will be included in the WEB-INF/lib-provided directory of the war.
getScript() - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
Returns the script File that will be included in the executable archive.
getVersion() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Returns the value used for the build.version property.

H

hashCode() - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
 
hashCode() - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
 

I

isExcludeDevtools() - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Returns true if the Devtools jar should be excluded, otherwise false.
isExcludeDevtools() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
isExcludeDevtools() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 

L

launchScript() - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Configures the archive to have a prepended launch script.
launchScript(Action<LaunchScriptConfiguration>) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Configures the archive to have a prepended launch script, customizing its configuration using the given action.
launchScript() - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
launchScript(Action<LaunchScriptConfiguration>) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
launchScript() - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
launchScript(Action<LaunchScriptConfiguration>) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
LaunchScriptConfiguration - Class in org.springframework.boot.gradle.tasks.bundling
Encapsulates the configuration of the launch script for an executable jar or war.
LaunchScriptConfiguration() - Constructor for class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
 

O

org.springframework.boot.gradle.dsl - package org.springframework.boot.gradle.dsl
Spring Boot Gradle DSL.
org.springframework.boot.gradle.plugin - package org.springframework.boot.gradle.plugin
Central classes for the Spring Boot Gradle plugin.
org.springframework.boot.gradle.tasks.application - package org.springframework.boot.gradle.tasks.application
Classes related to Gradle's application features.
org.springframework.boot.gradle.tasks.buildinfo - package org.springframework.boot.gradle.tasks.buildinfo
Support for producing build info for consumption by Spring Boot's actuator.
org.springframework.boot.gradle.tasks.bundling - package org.springframework.boot.gradle.tasks.bundling
Support for creating executable jars and wars.
org.springframework.boot.gradle.tasks.run - package org.springframework.boot.gradle.tasks.run
Support for running Spring Boot applications.

P

properties(Action<BuildInfoProperties>) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Executes the given action on the BuildInfo.getProperties() properties.
properties(Map<String, String>) - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
Sets the properties that are applied to the launch script when it's being including in the executable archive.
providedClasspath(Object...) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
Adds files to the provided classpath to include in the WEB-INF/lib-provided directory of the war.

R

requiresUnpack(String...) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.
requiresUnpack(Spec<FileTreeElement>) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Adds a spec that identifies files that must be unpacked from the archive when it is launched.
requiresUnpack(String...) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
requiresUnpack(Spec<FileTreeElement>) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
requiresUnpack(String...) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
requiresUnpack(Spec<FileTreeElement>) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
resolveZipCompression(FileCopyDetails) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
Returns the ZipCompression that should be used when adding the file represented by the given details to the jar.
resolveZipCompression(FileCopyDetails) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
Returns the ZipCompression that should be used when adding the file represented by the given details to the jar.
run() - Method in class org.springframework.boot.gradle.tasks.run.BootRun
 

S

setAdditional(Map<String, Object>) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Sets the additional properties that will be included.
setApplicationName(String) - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
setApplicationName(Provider<String>) - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
Sets the application name to the value from the given applicationNameProvider.
setArgs(List<String>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Configures the application to be run using the given args.
setArgs(Provider<List<String>>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Configures the application to be run using the args provided by the given argsProvider.
setArtifact(String) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Sets the value used for the build.artifact property.
setDestinationDir(File) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Sets the directory to which the build-info.properties file will be written.
setDestinationDir(Provider<File>) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfo
Sets the directory to which the build-info.properties file will be written to the value from the given destinationDirProvider.
setExcludeDevtools(boolean) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Sets whether or not the Devtools jar should be excluded.
setExcludeDevtools(boolean) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
setExcludeDevtools(boolean) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
setGroup(String) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Sets the value used for the build.group property.
setJvmArgs(Provider<List<String>>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Configures the application to be run using the JVM args provided by the given jvmArgsProvider.
setJvmArgs(List<String>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Configures the application to be run using the given jvmArgs.
setMain(Provider<String>) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Sets the main class to be executed using the given mainProvider.
setMain(String) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Sets the main class to be run.
setMainClass(String) - Method in interface org.springframework.boot.gradle.tasks.bundling.BootArchive
Sets the main class of the application.
setMainClass(String) - Method in class org.springframework.boot.gradle.tasks.bundling.BootJar
 
setMainClass(String) - Method in class org.springframework.boot.gradle.tasks.bundling.BootWar
 
setName(String) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Sets the value used for the build.name property.
setOutputDir(File) - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
 
setOutputDir(Provider<File>) - Method in class org.springframework.boot.gradle.tasks.application.CreateBootStartScripts
Sets the output directory to the value from the given outputDirProvider.
setScript(File) - Method in class org.springframework.boot.gradle.tasks.bundling.LaunchScriptConfiguration
Sets the script File that will be included in the executable archive.
setVersion(String) - Method in class org.springframework.boot.gradle.tasks.buildinfo.BuildInfoProperties
Sets the value used for the build.version property.
sourceResources(SourceSet) - Method in class org.springframework.boot.gradle.tasks.run.BootRun
Adds the source directories of the given sourceSet's resources to the start of the classpath in place of the output's resources directory.
SpringBootExtension - Class in org.springframework.boot.gradle.dsl
Entry point to Spring Boot's Gradle DSL.
SpringBootExtension(Project) - Constructor for class org.springframework.boot.gradle.dsl.SpringBootExtension
Creates a new SpringBootPluginExtension that is associated with the given project.
SpringBootPlugin - Class in org.springframework.boot.gradle.plugin
Gradle plugin for Spring Boot.
SpringBootPlugin() - Constructor for class org.springframework.boot.gradle.plugin.SpringBootPlugin
 

V

valueOf(String) - Static method in enum org.springframework.boot.gradle.tasks.bundling.ZipCompression
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.boot.gradle.tasks.bundling.ZipCompression
Returns an array containing the constants of this enum type, in the order they are declared.

Z

ZipCompression - Enum in org.springframework.boot.gradle.tasks.bundling
An enumeration of supported compression options for an entry in a ZIP archive.
A B C E G H I L O P R S V Z 
Skip navigation links