org.springframework.boot.loader.archive

Class ExplodedArchive

java.lang.Object

org.springframework.boot.loader.archive.ExplodedArchive

All Implemented Interfaces:

AutoCloseable, Iterable<Archive.Entry>, Archive

public class ExplodedArchive
extends Object
implements Archive

Archive implementation backed by an exploded archive directory.

Since:

1.0.0

Author:

Phillip Webb, Andy Wilkinson, Madhura Bhave

Nested Class Summary

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

Archive.Entry, Archive.EntryFilter

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
Manifest	getManifest() Returns the manifest of the archive.
protected Archive	getNestedArchive(Archive.Entry entry)
Iterator<Archive>	getNestedArchives(Archive.EntryFilter searchFilter, Archive.EntryFilter includeFilter) Returns nested Archives for entries that match the specified filters.
URL	getUrl() Returns a URL that can be used to load the archive.
boolean	isExploded() Return if the archive is exploded (already unpacked).
Iterator<Archive.Entry>	iterator() Return a new iterator for the archive entries.
String	toString()

Methods inherited from class java.lang.Object

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

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

close, getNestedArchives

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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 false.

Method Detail

getUrl

public URL getUrl()
           throws MalformedURLException

Description copied from interface: Archive

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

Specified by:

getUrl in interface Archive

Returns:

the archive URL

Throws:

MalformedURLException - if the URL is malformed

getManifest

public Manifest getManifest()
                     throws IOException

Description copied from interface: Archive

Returns the manifest of the archive.

Specified by:

getManifest in interface Archive

Returns:

the manifest

Throws:

IOException - if the manifest cannot be read

getNestedArchives

public Iterator<Archive> getNestedArchives(Archive.EntryFilter searchFilter,
                                           Archive.EntryFilter includeFilter)
                                    throws IOException

Description copied from interface: Archive

Returns nested Archives for entries that match the specified filters.

Specified by:

getNestedArchives in interface Archive

Parameters:

searchFilter - filter used to limit when additional sub-entry searching is required or null if all entries should be considered.

includeFilter - filter used to determine which entries should be included in the result or null if all entries should be included

Returns:

the nested archives

Throws:

IOException - on IO error

iterator

public Iterator<Archive.Entry> iterator()

Description copied from interface: Archive

Return a new iterator for the archive entries.

Specified by:

iterator in interface Iterable<Archive.Entry>

Specified by:

iterator in interface Archive

See Also:

Iterable.iterator()

getNestedArchive

protected Archive getNestedArchive(Archive.Entry entry)
                            throws IOException

Throws:

IOException

isExploded

public boolean isExploded()

Description copied from interface: Archive

Return if the archive is exploded (already unpacked).

Specified by:

isExploded in interface Archive

Returns:

if the archive is exploded

toString

public String toString()

Overrides:

toString in class Object