Package org.springframework.boot.gradle.tasks.bundling

Class LayeredSpec

java.lang.Object

org.springframework.boot.gradle.tasks.bundling.LayeredSpec

public abstract class LayeredSpec
extends Object

Encapsulates the configuration for a layered archive.

Since:

2.3.0

Author:

Madhura Bhave, Scott Frederick, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LayeredSpec.ApplicationSpec	An LayeredSpec.IntoLayersSpec that controls the layers to which application classes and resources belong.
static class	LayeredSpec.DependenciesIntoLayerSpec	Spec that controls the dependencies that should be part of a particular layer.
static class	LayeredSpec.DependenciesSpec	An LayeredSpec.IntoLayersSpec that controls the layers to which dependencies belong.
static class	LayeredSpec.IntoLayerSpec	Spec that controls the content that should be part of a particular layer.
static class	LayeredSpec.IntoLayersSpec<S extends LayeredSpec.IntoLayerSpec>	Base class for specs that control the layers to which a category of content should belong.

Constructor Summary

Constructors

Constructor	Description
LayeredSpec(ObjectFactory objects)

Method Summary

Modifier and Type	Method	Description
void	application(Action<LayeredSpec.ApplicationSpec> action)	Customizes the LayeredSpec.ApplicationSpec using the given action.
void	dependencies(Action<LayeredSpec.DependenciesSpec> action)	Customizes the LayeredSpec.DependenciesSpec using the given action.
LayeredSpec.ApplicationSpec	getApplication()	Returns the LayeredSpec.ApplicationSpec that controls the layers to which application classes and resources belong.
LayeredSpec.DependenciesSpec	getDependencies()	Returns the LayeredSpec.DependenciesSpec that controls the layers to which dependencies belong.
abstract Property<Boolean>	getEnabled()	Returns whether the layers.idx should be included in the archive.
abstract Property<Boolean>	getIncludeLayerTools()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.3.0 for removal in 3.5.0 in favor of includeTools.
abstract ListProperty<String>	getLayerOrder()	Returns the order of the layers in the archive from least to most frequently changing.
void	setApplication(LayeredSpec.ApplicationSpec spec)	Sets the LayeredSpec.ApplicationSpec that controls the layers to which application classes are resources belong.
void	setDependencies(LayeredSpec.DependenciesSpec spec)	Sets the LayeredSpec.DependenciesSpec that controls the layers to which dependencies belong.

Methods inherited from class java.lang.Object

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

Constructor Details

LayeredSpec

@Inject
public LayeredSpec(ObjectFactory objects)

Method Details

getIncludeLayerTools

@Input
@Deprecated(since="3.3.0",
            forRemoval=true)
public abstract Property<Boolean> getIncludeLayerTools()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.3.0 for removal in 3.5.0 in favor of includeTools.

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

Returns:

whether the layer tools should be included

Since:

3.0.0

getEnabled

@Input
public abstract Property<Boolean> getEnabled()

Returns whether the layers.idx should be included in the archive.

Returns:

whether the layers.idx should be included

Since:

3.0.0

getApplication

@Input
public LayeredSpec.ApplicationSpec getApplication()

Returns the LayeredSpec.ApplicationSpec that controls the layers to which application classes and resources belong.

Returns:

the application spec

setApplication

public void setApplication(LayeredSpec.ApplicationSpec spec)

Sets the LayeredSpec.ApplicationSpec that controls the layers to which application classes are resources belong.

Parameters:

spec - the application spec

application

public void application(Action<LayeredSpec.ApplicationSpec> action)

Customizes the LayeredSpec.ApplicationSpec using the given action.

Parameters:

action - the action

getDependencies

@Input
public LayeredSpec.DependenciesSpec getDependencies()

Returns the LayeredSpec.DependenciesSpec that controls the layers to which dependencies belong.

Returns:

the dependencies spec

setDependencies

public void setDependencies(LayeredSpec.DependenciesSpec spec)

Sets the LayeredSpec.DependenciesSpec that controls the layers to which dependencies belong.

Parameters:

spec - the dependencies spec

dependencies

public void dependencies(Action<LayeredSpec.DependenciesSpec> action)

Customizes the LayeredSpec.DependenciesSpec using the given action.

Parameters:

action - the action

getLayerOrder

@Input
@Optional
public abstract ListProperty<String> getLayerOrder()

Returns the order of the layers in the archive from least to most frequently changing.

Returns:

the layer order