org.springframework.boot.loader.tools

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 and Description
Library(File file, LibraryScope scope) Create a new Library.
Library(File file, LibraryScope scope, boolean unpackRequired) Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)
Library(String name, File file, LibraryScope scope, boolean unpackRequired) Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)
Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired) Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)
Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired, boolean local) Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)
Library(String name, File file, LibraryScope scope, LibraryCoordinates coordinates, boolean unpackRequired, boolean local, boolean included) Create a new Library.

Method Summary

Modifier and Type	Method and Description
LibraryCoordinates	getCoordinates() Return the coordinates of the library.
File	getFile() Return the library file.
String	getName() Return the name of file as it should be written.
LibraryScope	getScope() Return the scope of the library.
boolean	isIncluded() Return if the library is included in the fat 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 java.lang.Object

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

Constructor Detail

Library

public Library(File file,
               LibraryScope scope)

Create a new Library.

Parameters:

file - the source file

scope - the scope of the library

Library

@Deprecated
public Library(File file,
                           LibraryScope scope,
                           boolean unpackRequired)

Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)

Create a new Library.

Parameters:

file - the source file

scope - the scope of the library

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

Library

@Deprecated
public Library(String name,
                           File file,
                           LibraryScope scope,
                           boolean unpackRequired)

Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)

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

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

Library

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

Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)

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

Library

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

Deprecated. since 2.4.8 for removal in 2.6.0 in favor of Library(String, File, LibraryScope, LibraryCoordinates, boolean, boolean, boolean)

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

Since:

2.4.0

Library

public Library(String name,
               File file,
               LibraryScope scope,
               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 fat jar

Since:

2.4.8

Method Detail

getName

public String getName()

Return the name of file as it should be written.

Returns:

the name

getFile

public File getFile()

Return the library file.

Returns:

the file

getScope

public LibraryScope getScope()

Return the scope of the library.

Returns:

the scope

getCoordinates

public 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 fat jar.

Returns:

if the library is included