Class Library

java.lang.Object

org.springframework.boot.loader.tools.Library

Direct Known Subclasses:

JarModeLibrary

public class Library
extends Object

Encapsulates information about a single library that may be packed into the archive.

Since:

1.1.2

Author:

Phillip Webb, Scott Frederick

See Also:

• Libraries

Constructor Summary

Constructors

Constructor	Description
Library(File file, LibraryScope scope)	Create a new Library.
Library(@Nullable String name, @Nullable File file, @Nullable LibraryScope scope, @Nullable LibraryCoordinates coordinates, boolean unpackRequired, boolean local, boolean included)	Create a new Library.

Method Summary

Modifier and Type	Method	Description
@Nullable LibraryCoordinates	getCoordinates()	Return the coordinates of the library.
@Nullable File	getFile()	Return the library file.
String	getName()	Return the name of file as it should be written.
@Nullable LibraryScope	getScope()	Return the scope of the library.
boolean	isIncluded()	Return if the library is included in the uber jar.
boolean	isLocal()	Return if the library is local (part of the same build) to the application that is being packaged.
boolean	isUnpackRequired()	Return if the file cannot be used directly as a nested jar and needs to be unpacked.

Methods inherited from class Object

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

Constructor Details

Library

public Library(File file,
 LibraryScope scope)

Create a new Library.

Parameters:

file - the source file

scope - the scope of the library

Library

public Library(@Nullable String name,
 @Nullable File file,
 @Nullable LibraryScope scope,
 @Nullable LibraryCoordinates coordinates,
 boolean unpackRequired,
 boolean local,
 boolean included)

Create a new Library.

Parameters:

name - the name of the library as it should be written or null to use the file name

file - the source file

scope - the scope of the library

coordinates - the library coordinates or null

unpackRequired - if the library needs to be unpacked before it can be used

local - if the library is local (part of the same build) to the application that is being packaged

included - if the library is included in the uber jar

Since:

2.4.8

Method Details

getName

public String getName()

Return the name of file as it should be written.

Returns:

the name

getFile

public @Nullable File getFile()

Return the library file.

Returns:

the file

getScope

public @Nullable LibraryScope getScope()

Return the scope of the library.

Returns:

the scope

getCoordinates

public @Nullable LibraryCoordinates getCoordinates()

Return the coordinates of the library.

Returns:

the coordinates

isUnpackRequired

public boolean isUnpackRequired()

Return if the file cannot be used directly as a nested jar and needs to be unpacked.

Returns:

if unpack is required

isLocal

public boolean isLocal()

Return if the library is local (part of the same build) to the application that is being packaged.

Returns:

if the library is local

isIncluded

public boolean isIncluded()

Return if the library is included in the uber jar.

Returns:

if the library is included