Package org.springframework.boot.loader.jar

Class JarFile

java.lang.Object

java.util.zip.ZipFile

java.util.jar.JarFile

org.springframework.boot.loader.jar.JarFile

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<JarEntry>

public class JarFile
extends JarFile
implements Iterable<JarEntry>

Extended variant of JarFile that behaves in the same way but offers the following additional functionality.

• A nested JarFile can be obtained based on any directory entry.
• A nested JarFile can be obtained for embedded JAR files (as long as their entry is not compressed).

Since:

1.0.0

Author:

Phillip Webb, Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CENATT
static final int	CENATX
static final int	CENCOM
static final int	CENCRC
static final int	CENDSK
static final int	CENEXT
static final int	CENFLG
static final int	CENHDR
static final int	CENHOW
static final int	CENLEN
static final int	CENNAM
static final int	CENOFF
static final long	CENSIG
static final int	CENSIZ
static final int	CENTIM
static final int	CENVEM
static final int	CENVER
static final int	ENDCOM
static final int	ENDHDR
static final int	ENDOFF
static final long	ENDSIG
static final int	ENDSIZ
static final int	ENDSUB
static final int	ENDTOT
static final int	EXTCRC
static final int	EXTHDR
static final int	EXTLEN
static final long	EXTSIG
static final int	EXTSIZ
static final int	LOCCRC
static final int	LOCEXT
static final int	LOCFLG
static final int	LOCHDR
static final int	LOCHOW
static final int	LOCLEN
static final int	LOCNAM
static final long	LOCSIG
static final int	LOCSIZ
static final int	LOCTIM
static final int	LOCVER

Fields inherited from class java.util.zip.ZipFile

OPEN_DELETE, OPEN_READ

Constructor Summary

Constructors

Constructor	Description
JarFile(File file)	Create a new JarFile backed by the specified file.

Method Summary

Modifier and Type	Method	Description
void	clearCache()
void	close()
boolean	containsEntry(String name)
Enumeration<JarEntry>	entries()
String	getComment()
ZipEntry	getEntry(String name)
InputStream	getInputStream(ZipEntry entry)
org.springframework.boot.loader.jar.JarEntry	getJarEntry(CharSequence name)
org.springframework.boot.loader.jar.JarEntry	getJarEntry(String name)
Manifest	getManifest()
String	getName()
JarFile	getNestedJarFile(ZipEntry entry)	Return a nested JarFile loaded from the specified entry.
JarFile	getNestedJarFile(org.springframework.boot.loader.jar.JarEntry entry)	Return a nested JarFile loaded from the specified entry.
protected String	getPathFromRoot()
protected final RandomAccessDataFile	getRootJarFile()
URL	getUrl()
Iterator<JarEntry>	iterator()	Return an iterator for the contained entries.
static void	registerUrlProtocolHandler()	Register a 'java.protocol.handler.pkgs' property so that a URLStreamHandler will be located to deal with jar URLs.
int	size()
Stream<JarEntry>	stream()
String	toString()

Methods inherited from class java.util.jar.JarFile

baseVersion, getVersion, isMultiRelease, runtimeVersion, versionedStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

LOCSIG

static final long LOCSIG

See Also:

• Constant Field Values

EXTSIG

static final long EXTSIG

See Also:

• Constant Field Values

CENSIG

static final long CENSIG

See Also:

• Constant Field Values

ENDSIG

static final long ENDSIG

See Also:

• Constant Field Values

LOCHDR

static final int LOCHDR

See Also:

• Constant Field Values

EXTHDR

static final int EXTHDR

See Also:

• Constant Field Values

CENHDR

static final int CENHDR

See Also:

• Constant Field Values

ENDHDR

static final int ENDHDR

See Also:

• Constant Field Values

LOCVER

static final int LOCVER

See Also:

• Constant Field Values

LOCFLG

static final int LOCFLG

See Also:

• Constant Field Values

LOCHOW

static final int LOCHOW

See Also:

• Constant Field Values

LOCTIM

static final int LOCTIM

See Also:

• Constant Field Values

LOCCRC

static final int LOCCRC

See Also:

• Constant Field Values

LOCSIZ

static final int LOCSIZ

See Also:

• Constant Field Values

LOCLEN

static final int LOCLEN

See Also:

• Constant Field Values

LOCNAM

static final int LOCNAM

See Also:

• Constant Field Values

LOCEXT

static final int LOCEXT

See Also:

• Constant Field Values

EXTCRC

static final int EXTCRC

See Also:

• Constant Field Values

EXTSIZ

static final int EXTSIZ

See Also:

• Constant Field Values

EXTLEN

static final int EXTLEN

See Also:

• Constant Field Values

CENVEM

static final int CENVEM

See Also:

• Constant Field Values

CENVER

static final int CENVER

See Also:

• Constant Field Values

CENFLG

static final int CENFLG

See Also:

• Constant Field Values

CENHOW

static final int CENHOW

See Also:

• Constant Field Values

CENTIM

static final int CENTIM

See Also:

• Constant Field Values

CENCRC

static final int CENCRC

See Also:

• Constant Field Values

CENSIZ

static final int CENSIZ

See Also:

• Constant Field Values

CENLEN

static final int CENLEN

See Also:

• Constant Field Values

CENNAM

static final int CENNAM

See Also:

• Constant Field Values

CENEXT

static final int CENEXT

See Also:

• Constant Field Values

CENCOM

static final int CENCOM

See Also:

• Constant Field Values

CENDSK

static final int CENDSK

See Also:

• Constant Field Values

CENATT

static final int CENATT

See Also:

• Constant Field Values

CENATX

static final int CENATX

See Also:

• Constant Field Values

CENOFF

static final int CENOFF

See Also:

• Constant Field Values

ENDSUB

static final int ENDSUB

See Also:

• Constant Field Values

ENDTOT

static final int ENDTOT

See Also:

• Constant Field Values

ENDSIZ

static final int ENDSIZ

See Also:

• Constant Field Values

ENDOFF

static final int ENDOFF

See Also:

• Constant Field Values

ENDCOM

static final int ENDCOM

See Also:

• Constant Field Values

Constructor Details

JarFile

public JarFile(File file)
        throws IOException

Create a new JarFile backed by the specified file.

Parameters:

file - the root jar file

Throws:

IOException - if the file cannot be read

Method Details

getRootJarFile

protected final RandomAccessDataFile getRootJarFile()

getManifest

public Manifest getManifest()
                     throws IOException

Overrides:

getManifest in class JarFile

Throws:

IOException

entries

public Enumeration<JarEntry> entries()

Overrides:

entries in class JarFile

stream

public Stream<JarEntry> stream()

Overrides:

stream in class JarFile

iterator

public Iterator<JarEntry> iterator()

Return an iterator for the contained entries.

Specified by:

iterator in interface Iterable<JarEntry>

Since:

2.3.0

See Also:

• Iterable.iterator()

getJarEntry

public org.springframework.boot.loader.jar.JarEntry getJarEntry(CharSequence name)

getJarEntry

public org.springframework.boot.loader.jar.JarEntry getJarEntry(String name)

Overrides:

getJarEntry in class JarFile

containsEntry

public boolean containsEntry(String name)

getEntry

public ZipEntry getEntry(String name)

Overrides:

getEntry in class JarFile

getInputStream

public InputStream getInputStream(ZipEntry entry)
                           throws IOException

Overrides:

getInputStream in class JarFile

Throws:

IOException

getNestedJarFile

public JarFile getNestedJarFile(ZipEntry entry)
                         throws IOException

Return a nested JarFile loaded from the specified entry.

Parameters:

entry - the zip entry

Returns:

a JarFile for the entry

Throws:

IOException - if the nested jar file cannot be read

getNestedJarFile

public JarFile getNestedJarFile(org.springframework.boot.loader.jar.JarEntry entry)
                         throws IOException

Return a nested JarFile loaded from the specified entry.

Parameters:

entry - the zip entry

Returns:

a JarFile for the entry

Throws:

IOException - if the nested jar file cannot be read

getComment

public String getComment()

Overrides:

getComment in class ZipFile

size

public int size()

Overrides:

size in class ZipFile

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ZipFile

Throws:

IOException

getUrl

public URL getUrl()
           throws MalformedURLException

Throws:

MalformedURLException

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Overrides:

getName in class ZipFile

clearCache

public void clearCache()

getPathFromRoot

protected String getPathFromRoot()

registerUrlProtocolHandler

public static void registerUrlProtocolHandler()

Register a 'java.protocol.handler.pkgs' property so that a URLStreamHandler will be located to deal with jar URLs.