org.springframework.boot.loader.archive

Class ExplodedArchive

java.lang.Object

org.springframework.boot.loader.archive.Archive

org.springframework.boot.loader.archive.ExplodedArchive

public class ExplodedArchive
extends Archive

Archive implementation backed by an exploded archive directory.

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.loader.archive.Archive

Archive.Entry, Archive.EntryFilter, Archive.EntryRenameFilter

Constructor Summary

Constructors

Constructor and Description
ExplodedArchive(File root) Create a new ExplodedArchive instance.
ExplodedArchive(File root, boolean recursive) Create a new ExplodedArchive instance.

Method Summary

Modifier and Type	Method and Description
Collection<Archive.Entry>	getEntries() Returns all entries from the archive.
Archive	getFilteredArchive(Archive.EntryRenameFilter filter) Returns a filtered version of the archive.
Manifest	getManifest() Returns the manifest of the archive.
protected Archive	getNestedArchive(Archive.Entry entry)
List<Archive>	getNestedArchives(Archive.EntryFilter filter) Returns nested Archives for entries that match the specified filter.
URL	getUrl() Returns a URL that can be used to load the archive.

Methods inherited from class org.springframework.boot.loader.archive.Archive

getMainClass, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplodedArchive

public ExplodedArchive(File root)

Create a new ExplodedArchive instance.

Parameters:

root - the root folder

ExplodedArchive

public ExplodedArchive(File root,
                       boolean recursive)

Create a new ExplodedArchive instance.

Parameters:

root - the root folder

recursive - if recursive searching should be used to locate the manifest. Defaults to true, folders with a large tree might want to set this to {code false}.

Method Detail

getUrl

public URL getUrl()
           throws MalformedURLException

Description copied from class: Archive

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

Specified by:

getUrl in class Archive

Returns:

the archive URL

Throws:

MalformedURLException - if the URL is malformed

getManifest

public Manifest getManifest()
                     throws IOException

Description copied from class: Archive

Returns the manifest of the archive.

Specified by:

getManifest in class Archive

Returns:

the manifest

Throws:

IOException - if the manifest cannot be read

getNestedArchives

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

Description copied from class: Archive

Returns nested Archives for entries that match the specified filter.

Specified by:

getNestedArchives in class Archive

Parameters:

filter - the filter used to limit entries

Returns:

nested archives

Throws:

IOException - if nested archives cannot be read

getEntries

public Collection<Archive.Entry> getEntries()

Description copied from class: Archive

Returns all entries from the archive.

Specified by:

getEntries in class Archive

Returns:

the archive entries

getNestedArchive

protected Archive getNestedArchive(Archive.Entry entry)
                            throws IOException

Throws:

IOException

getFilteredArchive

public Archive getFilteredArchive(Archive.EntryRenameFilter filter)
                           throws IOException

Description copied from class: Archive

Returns a filtered version of the archive.

Specified by:

getFilteredArchive in class Archive

Parameters:

filter - the filter to apply

Returns:

a filter archive

Throws:

IOException - if the archive cannot be read