org.springframework.boot.loader.archive

Interface Archive

All Superinterfaces:

AutoCloseable, Iterable<Archive.Entry>

All Known Implementing Classes:

ExplodedArchive, JarFileArchive

public interface Archive
extends Iterable<Archive.Entry>, AutoCloseable

An archive that can be launched by the Launcher.

Since:

1.0.0

Author:

Phillip Webb

See Also:

JarFileArchive

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
default void	close() Closes the Archive, releasing any open resources.
default void	forEach(Consumer<? super Archive.Entry> action) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
Manifest	getManifest() Returns the manifest of the archive.
default List<Archive>	getNestedArchives(Archive.EntryFilter filter) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getNestedArchives(EntryFilter, EntryFilter)
default 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.
default boolean	isExploded() Return if the archive is exploded (already unpacked).
Iterator<Archive.Entry>	iterator() Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.
default Spliterator<Archive.Entry>	spliterator() Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.

Method Detail

getUrl

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

getManifest

Manifest getManifest()
              throws IOException

Returns the manifest of the archive.

Returns:

the manifest

Throws:

IOException - if the manifest cannot be read

getNestedArchives

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

Returns nested Archives for entries that match the specified filters.

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

Since:

2.3.0

getNestedArchives

@Deprecated
default List<Archive> getNestedArchives(Archive.EntryFilter filter)
                                             throws IOException

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getNestedArchives(EntryFilter, EntryFilter)

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

iterator

@Deprecated
Iterator<Archive.Entry> iterator()

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.

Return a new iterator for the archive entries.

Specified by:

iterator in interface Iterable<Archive.Entry>

See Also:

Iterable.iterator()

forEach

@Deprecated
default void forEach(Consumer<? super Archive.Entry> action)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface Iterable<Archive.Entry>

See Also:

Iterable.forEach(java.util.function.Consumer<? super T>)

spliterator

@Deprecated
default Spliterator<Archive.Entry> spliterator()

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of using JarFile to access entries and getNestedArchives(EntryFilter, EntryFilter) for accessing nested archives.

Creates a Spliterator over the elements described by this Iterable.

Specified by:

spliterator in interface Iterable<Archive.Entry>

See Also:

Iterable.spliterator()

isExploded

default boolean isExploded()

Return if the archive is exploded (already unpacked).

Returns:

if the archive is exploded

Since:

2.3.0

close

default void close()
            throws Exception

Closes the Archive, releasing any open resources.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if an error occurs during close processing

Since:

2.2.0