org.springframework.boot.loader.archive

Class JarFileArchive

java.lang.Object

org.springframework.boot.loader.archive.JarFileArchive

All Implemented Interfaces:

AutoCloseable, Iterable<Archive.Entry>, Archive

public class JarFileArchive
extends Object
implements Archive

Archive implementation backed by a JarFile.

Since:

1.0.0

Author:

Phillip Webb, Andy Wilkinson

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
JarFileArchive(File file)
JarFileArchive(File file, URL url)
JarFileArchive(JarFile jarFile)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Archive, releasing any open resources.
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.
Iterator<Archive.Entry>	iterator() Deprecated.
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

forEach, getNestedArchives, isExploded, spliterator

Constructor Detail

JarFileArchive

public JarFileArchive(File file)
               throws IOException

Throws:

IOException

JarFileArchive

public JarFileArchive(File file,
                      URL url)
               throws IOException

Throws:

IOException

JarFileArchive

public JarFileArchive(JarFile jarFile)

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

@Deprecated
public Iterator<Archive.Entry> iterator()

Deprecated.

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:

{@link org.springframework.boot.loader.jar.JarFile} to access entries and {@link #getNestedArchives(EntryFilter, EntryFilter)} for accessing nested archives.

close

public void close()
           throws IOException

Description copied from interface: Archive

Closes the Archive, releasing any open resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Archive

Throws:

IOException

getNestedArchive

protected Archive getNestedArchive(Archive.Entry entry)
                            throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object