org.springframework.boot.loader.tools

Interface Layout

All Known Subinterfaces:

RepackagingLayout

All Known Implementing Classes:

Layouts.Expanded, Layouts.Jar, Layouts.None, Layouts.War

public interface Layout

Strategy interface used to determine the layout for a particular type of archive. Layouts may additionally implement CustomLoaderLayout if they wish to write custom loader classes.

Since:

1.0.0

Author:

Phillip Webb

See Also:

Layouts, RepackagingLayout, CustomLoaderLayout

Method Summary

Modifier and Type	Method and Description
String	getClassesLocation() Returns the location of classes within the archive.
String	getLauncherClassName() Returns the launcher class name for this layout.
String	getLibraryDestination(String libraryName, LibraryScope scope) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getLibraryLocation(java.lang.String, org.springframework.boot.loader.tools.LibraryScope)
default String	getLibraryLocation(String libraryName, LibraryScope scope) Returns the destination path for a given library.
boolean	isExecutable() Returns if loader classes should be included to make the archive executable.

Method Detail

getLauncherClassName

String getLauncherClassName()

Returns the launcher class name for this layout.

Returns:

the launcher class name

getLibraryLocation

default String getLibraryLocation(String libraryName,
                                  LibraryScope scope)

Returns the destination path for a given library.

Parameters:

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

scope - the scope of the library

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.

getLibraryDestination

@Deprecated
String getLibraryDestination(String libraryName,
                                         LibraryScope scope)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getLibraryLocation(java.lang.String, org.springframework.boot.loader.tools.LibraryScope)

Returns the destination path for a given library.

Parameters:

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

scope - the scope of the library

Returns:

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

getClassesLocation

String getClassesLocation()

Returns the location of classes within the archive.

Returns:

the classes location

isExecutable

boolean isExecutable()

Returns if loader classes should be included to make the archive executable.

Returns:

if the layout is executable