org.springframework.boot.loader.tools

Interface LayeredLayout

All Superinterfaces:

Layout, RepackagingLayout

All Known Implementing Classes:

Layouts.LayeredJar

public interface LayeredLayout
extends RepackagingLayout

A specialization of RepackagingLayout that supports layers in the repackaged archive.

Since:

2.3.0

Author:

Madhura Bhave, Phillip Webb

Method Summary

Modifier and Type	Method and Description
String	getLayersIndexFileLocation() Returns the location of the layers index file that should be written or null if not index is required.
String	getLibraryLocation(String libraryName, LibraryScope scope, Layer layer) Returns the destination path for a given library within the context of a layer.
String	getRepackagedClassesLocation(Layer layer) Returns the location to which classes should be moved within the context of a layer.

Methods inherited from interface org.springframework.boot.loader.tools.RepackagingLayout

getClasspathIndexFileLocation, getRepackagedClassesLocation

Methods inherited from interface org.springframework.boot.loader.tools.Layout

getClassesLocation, getLauncherClassName, getLibraryDestination, getLibraryLocation, isExecutable

Method Detail

getLayersIndexFileLocation

String getLayersIndexFileLocation()

Returns the location of the layers index file that should be written or null if not index is required. The result should include the filename and is relative to the root of the jar.

Returns:

the layers index file location

getRepackagedClassesLocation

String getRepackagedClassesLocation(Layer layer)

Returns the location to which classes should be moved within the context of a layer.

Parameters:

layer - the destination layer for the content

Returns:

the repackaged classes location

getLibraryLocation

String getLibraryLocation(String libraryName,
                          LibraryScope scope,
                          Layer layer)

Returns the destination path for a given library within the context of a layer.

Parameters:

libraryName - the name of the library (excluding any path)

scope - the scope of the library

layer - the destination layer for the content

Returns:

the location of the library relative to the root of the archive (should end with '/') or null if the library should not be included.