org.springframework.boot.loader.tools

Class Layouts.Jar

java.lang.Object

org.springframework.boot.loader.tools.Layouts.Jar

All Implemented Interfaces:

Layout, RepackagingLayout

Direct Known Subclasses:

Layouts.Expanded, Layouts.LayeredJar, Layouts.None

Enclosing class:

Layouts

public static class Layouts.Jar
extends Object
implements RepackagingLayout

Executable JAR layout.

Constructor Summary

Constructors

Constructor and Description
Jar()

Method Summary

Modifier and Type	Method and Description
String	getClassesLocation() Returns the location of classes within the archive.
String	getClasspathIndexFileLocation() Returns the location of the classpath index file that should be written or null if not index is required.
String	getLauncherClassName() Returns the launcher class name for this layout.
String	getLibraryDestination(String libraryName, LibraryScope scope) Deprecated.
String	getLibraryLocation(String libraryName, LibraryScope scope) Returns the destination path for a given library.
String	getRepackagedClassesLocation() Returns the location to which classes should be moved.
boolean	isExecutable() Returns if loader classes should be included to make the archive executable.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jar

public Jar()

Method Detail

getLauncherClassName

public String getLauncherClassName()

Description copied from interface: Layout

Returns the launcher class name for this layout.

Specified by:

getLauncherClassName in interface Layout

Returns:

the launcher class name

getLibraryLocation

public String getLibraryLocation(String libraryName,
                                 LibraryScope scope)

Description copied from interface: Layout

Returns the destination path for a given library.

Specified by:

getLibraryLocation in interface Layout

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
public String getLibraryDestination(String libraryName,
                                                LibraryScope scope)

Deprecated.

Description copied from interface: Layout

Returns the destination path for a given library.

Specified by:

getLibraryDestination in interface Layout

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

public String getClassesLocation()

Description copied from interface: Layout

Returns the location of classes within the archive.

Specified by:

getClassesLocation in interface Layout

Returns:

the classes location

getRepackagedClassesLocation

public String getRepackagedClassesLocation()

Description copied from interface: RepackagingLayout

Returns the location to which classes should be moved.

Specified by:

getRepackagedClassesLocation in interface RepackagingLayout

Returns:

the repackaged classes location

getClasspathIndexFileLocation

public String getClasspathIndexFileLocation()

Description copied from interface: RepackagingLayout

Returns the location of the classpath 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.

Specified by:

getClasspathIndexFileLocation in interface RepackagingLayout

Returns:

the classpath index file location

isExecutable

public boolean isExecutable()

Description copied from interface: Layout

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

Specified by:

isExecutable in interface Layout

Returns:

if the layout is executable