org.springframework.boot.loader.archive

Class Archive

java.lang.Object

org.springframework.boot.loader.archive.Archive

Direct Known Subclasses:

ExplodedArchive, FilteredArchive, JarFileArchive

public abstract class Archive
extends Object

An archive that can be launched by the Launcher.

Author:

Phillip Webb

See Also:

JarFileArchive

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Archive.Entry Represents a single entry in the archive.
static interface	Archive.EntryFilter Strategy interface to filter Entries.
static interface	Archive.EntryRenameFilter Strategy interface to filter or rename Entries.

Constructor Summary

Constructors

Constructor and Description
Archive()

Method Summary

Modifier and Type	Method and Description
abstract Collection<Archive.Entry>	getEntries() Returns all entries from the archive.
abstract Archive	getFilteredArchive(Archive.EntryRenameFilter filter) Returns a filtered version of the archive.
String	getMainClass() Obtain the main class that should be used to launch the application.
abstract Manifest	getManifest() Returns the manifest of the archive.
abstract List<Archive>	getNestedArchives(Archive.EntryFilter filter) Returns nested Archives for entries that match the specified filter.
abstract URL	getUrl() Returns a URL that can be used to load the archive.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Archive

public Archive()

Method Detail

getUrl

public abstract URL getUrl()
                    throws MalformedURLException

Returns a URL that can be used to load the archive.

Returns:

the archive URL

Throws:

MalformedURLException - if the URL is malformed

getMainClass

public String getMainClass()
                    throws Exception

Obtain the main class that should be used to launch the application. By default this method uses a Start-Class manifest entry.

Returns:

the main class

Throws:

Exception - if the main class cannot be obtained

toString

public String toString()

Overrides:

toString in class Object

getManifest

public abstract Manifest getManifest()
                              throws IOException

Returns the manifest of the archive.

Returns:

the manifest

Throws:

IOException - if the manifest cannot be read

getEntries

public abstract Collection<Archive.Entry> getEntries()

Returns all entries from the archive.

Returns:

the archive entries

getNestedArchives

public abstract List<Archive> getNestedArchives(Archive.EntryFilter filter)
                                         throws IOException

Returns nested Archives for entries that match the specified filter.

Parameters:

filter - the filter used to limit entries

Returns:

nested archives

Throws:

IOException - if nested archives cannot be read

getFilteredArchive

public abstract Archive getFilteredArchive(Archive.EntryRenameFilter filter)
                                    throws IOException

Returns a filtered version of the archive.

Parameters:

filter - the filter to apply

Returns:

a filter archive

Throws:

IOException - if the archive cannot be read