Interface BootArchive

All Superinterfaces:

Comparable<Task>, ExtensionAware, Named, Task

All Known Implementing Classes:

BootJar, BootWar

public interface BootArchive
extends Task

A Spring Boot "fat" archive task.

Since:

2.0.0

Author:

Andy Wilkinson, Moritz Halbritter

Nested Class Summary

Nested classes/interfaces inherited from interface Named

Named.Namer

Field Summary

Fields inherited from interface 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	Description
void	classpath(Object... classpath)	Adds files to the classpath to include in the archive.
@Nullable FileCollection	getClasspath()	Returns the classpath that will be included in the archive.
Property<Boolean>	getIncludeTools()	Returns whether the JAR tools should be included as a dependency in the layered archive.
Property<String>	getMainClass()	Returns the fully-qualified name of the application's main class.
Property<JavaVersion>	getTargetJavaVersion()	Returns the target Java version of the project (e.g.
void	requiresUnpack(String... patterns)	Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.
void	requiresUnpack(Spec<FileTreeElement> spec)	Adds a spec that identifies files that must be unpacked from the archive when it is launched.
void	resolvedArtifacts(Provider<Set<ResolvedArtifactResult>> resolvedArtifacts)	Registers the given lazily provided resolvedArtifacts.
void	setClasspath(Object classpath)	Sets the classpath to include in the archive.
void	setClasspath(FileCollection classpath)	Sets the classpath to include in the archive.

Methods inherited from interface Comparable

compareTo

Methods inherited from interface ExtensionAware

getExtensions

Methods inherited from interface Task

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

Method Details

getMainClass

@Input
Property<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

requiresUnpack

void requiresUnpack(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(Spec<FileTreeElement> spec)

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

Parameters:

spec - the spec

getClasspath

@Optional
@Classpath
@Nullable FileCollection getClasspath()

Returns the classpath that will be included in the archive.

Returns:

the classpath

classpath

void classpath(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(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(FileCollection classpath)

Sets the classpath to include in the archive.

Parameters:

classpath - the classpath

Since:

2.0.7

getTargetJavaVersion

@Input
@Optional
Property<JavaVersion> getTargetJavaVersion()

Returns the target Java version of the project (e.g. as provided by the targetCompatibility build property).

Returns:

the target Java version

resolvedArtifacts

void resolvedArtifacts(Provider<Set<ResolvedArtifactResult>> resolvedArtifacts)

Registers the given lazily provided resolvedArtifacts. They are used to map from the files in the classpath to their dependency coordinates.

Parameters:

resolvedArtifacts - the lazily provided resolved artifacts

Since:

3.0.7

getIncludeTools

@Input
Property<Boolean> getIncludeTools()

Returns whether the JAR tools should be included as a dependency in the layered archive.

Returns:

whether the JAR tools should be included

Since:

3.3.0