org.springframework.boot.gradle.tasks.bundling

Interface BootArchive

All Superinterfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task

All Known Implementing Classes:

BootJar, BootWar

public interface BootArchive
extends org.gradle.api.Task

A Spring Boot "fat" archive task.

Since:

2.0.0

Author:

Andy Wilkinson

Nested Class Summary

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

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

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

Method Summary

Modifier and Type	Method and Description
void	classpath(java.lang.Object... classpath) Adds files to the classpath to include in the archive.
org.gradle.api.file.FileCollection	getClasspath() Returns the classpath that will be included in the archive.
LaunchScriptConfiguration	getLaunchScript() Returns the LaunchScriptConfiguration that will control the script that is prepended to the archive.
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 in favor of getMainClass().
boolean	isExcludeDevtools() Deprecated. since 2.3.0 in favour of configuring a classpath that does not include development-only dependencies
void	launchScript() Configures the archive to have a prepended launch script.
void	launchScript(org.gradle.api.Action<LaunchScriptConfiguration> action) Configures the archive to have a prepended launch script, customizing its configuration using the given action.
void	requiresUnpack(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec) Adds a spec that identifies files that must be unpacked from the archive when it is launched.
void	requiresUnpack(java.lang.String... patterns) Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.
void	setClasspath(org.gradle.api.file.FileCollection classpath) Sets the classpath to include in the archive.
void	setClasspath(java.lang.Object classpath) Sets the classpath to include in the archive.
void	setExcludeDevtools(boolean excludeDevtools) Deprecated. since 2.3.0 in favour of configuring a classpath that does not include development-only dependencies
void	setMainClassName(java.lang.String mainClassName) Deprecated. since 2.4.0 in favour of getMainClass() and Property.set(Object)

Methods inherited from interface org.gradle.api.Task

configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.gradle.api.plugins.ExtensionAware

getExtensions

Method Detail

getMainClass

@Input
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")
java.lang.String getMainClassName()

Deprecated. since 2.4.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
void setMainClassName(java.lang.String mainClassName)

Deprecated. since 2.4.0 in favour 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

requiresUnpack

void requiresUnpack(java.lang.String... patterns)

Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.

Parameters:

patterns - the patterns

requiresUnpack

void requiresUnpack(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)

Adds a spec that identifies files that must be unpacked from the archive when it is launched.

Parameters:

spec - the spec

getLaunchScript

@Input
 @Optional
LaunchScriptConfiguration getLaunchScript()

Returns the LaunchScriptConfiguration that will control the script that is prepended to the archive.

Returns:

the launch script configuration, or null if the launch script has not been configured.

launchScript

void launchScript()

Configures the archive to have a prepended launch script.

launchScript

void launchScript(org.gradle.api.Action<LaunchScriptConfiguration> action)

Configures the archive to have a prepended launch script, customizing its configuration using the given action.

Parameters:

action - the action to apply

getClasspath

@Optional
 @Classpath
org.gradle.api.file.FileCollection getClasspath()

Returns the classpath that will be included in the archive.

Returns:

the classpath

classpath

void classpath(java.lang.Object... classpath)

Adds files to the classpath to include in the archive. The given classpath is evaluated as per Project.files(Object...).

Parameters:

classpath - the additions to the classpath

setClasspath

void setClasspath(java.lang.Object classpath)

Sets the classpath to include in the archive. The given classpath is evaluated as per Project.files(Object...).

Parameters:

classpath - the classpath

Since:

2.0.7

setClasspath

void setClasspath(org.gradle.api.file.FileCollection classpath)

Sets the classpath to include in the archive.

Parameters:

classpath - the classpath

Since:

2.0.7

isExcludeDevtools

@Input
 @Deprecated
boolean isExcludeDevtools()

Deprecated. since 2.3.0 in favour of configuring a classpath that does not include development-only dependencies

Returns true if the Devtools jar should be excluded, otherwise false.

Returns:

true if the Devtools jar should be excluded, or false if not

setExcludeDevtools

@Deprecated
void setExcludeDevtools(boolean excludeDevtools)

Deprecated. since 2.3.0 in favour of configuring a classpath that does not include development-only dependencies

Sets whether or not the Devtools jar should be excluded.

Parameters:

excludeDevtools - true if the Devtools jar should be excluded, or false if not