org.springframework.boot.gradle.tasks.bundling

Class LayeredSpec

java.lang.Object

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

public class LayeredSpec
extends java.lang.Object

Encapsulates the configuration for a layered jar.

Since:

2.3.0

Author:

Madhura Bhave, Scott Frederick, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 Base class for specs that control the layers to which a category of content should belong.

Constructor Summary

Constructors

Constructor and Description
LayeredSpec()

Method Summary

Modifier and Type	Method and Description
void	application(org.gradle.api.Action<LayeredSpec.ApplicationSpec> action) Customizes the LayeredSpec.ApplicationSpec using the given action.
void	application(groovy.lang.Closure<?> closure) Customizes the LayeredSpec.ApplicationSpec using the given closure.
void	dependencies(org.gradle.api.Action<LayeredSpec.DependenciesSpec> action) Customizes the LayeredSpec.DependenciesSpec using the given action.
void	dependencies(groovy.lang.Closure<?> closure) Customizes the LayeredSpec.DependenciesSpec using the given closure.
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.
java.util.List<java.lang.String>	getLayerOrder() Returns the order of the layers in the jar from least to most frequently changing.
boolean	isEnabled() Returns whether the layers.idx should be included in the jar.
boolean	isIncludeLayerTools() Returns whether the layer tools should be included as a dependency in the layered jar.
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.
void	setEnabled(boolean enabled) Sets whether the layers.idx should be included in the jar.
void	setIncludeLayerTools(boolean includeLayerTools) Sets whether the layer tools should be included as a dependency in the layered jar.
void	setLayerOrder(java.util.List<java.lang.String> layerOrder) Sets to order of the layers in the jar from least to most frequently changing.
void	setLayerOrder(java.lang.String... layerOrder) Sets to order of the layers in the jar from least to most frequently changing.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayeredSpec

public LayeredSpec()

Method Detail

isIncludeLayerTools

@Input
public boolean isIncludeLayerTools()

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

Returns:

whether the layer tools should be included

setIncludeLayerTools

public void setIncludeLayerTools(boolean includeLayerTools)

Sets whether the layer tools should be included as a dependency in the layered jar.

Parameters:

includeLayerTools - true if the layer tools should be included, otherwise false

isEnabled

@Input
public boolean isEnabled()

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

Returns:

whether the layers.idx should be included

setEnabled

public void setEnabled(boolean enabled)

Sets whether the layers.idx should be included in the jar.

Parameters:

enabled - true layers.idx should be included in the jar, otherwise false

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(org.gradle.api.Action<LayeredSpec.ApplicationSpec> action)

Customizes the LayeredSpec.ApplicationSpec using the given action.

Parameters:

action - the action

application

public void application(groovy.lang.Closure<?> closure)

Customizes the LayeredSpec.ApplicationSpec using the given closure.

Parameters:

closure - the closure

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(org.gradle.api.Action<LayeredSpec.DependenciesSpec> action)

Customizes the LayeredSpec.DependenciesSpec using the given action.

Parameters:

action - the action

dependencies

public void dependencies(groovy.lang.Closure<?> closure)

Customizes the LayeredSpec.DependenciesSpec using the given closure.

Parameters:

closure - the closure

getLayerOrder

@Input
public java.util.List<java.lang.String> getLayerOrder()

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

Returns:

the layer order

setLayerOrder

public void setLayerOrder(java.lang.String... layerOrder)

Sets to order of the layers in the jar from least to most frequently changing.

Parameters:

layerOrder - the layer order

setLayerOrder

public void setLayerOrder(java.util.List<java.lang.String> layerOrder)

Sets to order of the layers in the jar from least to most frequently changing.

Parameters:

layerOrder - the layer order