JarFile (Spring Boot Docs 1.3.2.RELEASE API)

java.lang.Object
- java.util.zip.ZipFile
- - java.util.jar.JarFile
  - - org.springframework.boot.loader.jar.JarFile

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<JarEntryData>
```
public class JarFile
extends JarFile
implements Iterable<JarEntryData>
```
Extended variant of JarFile that behaves in the same way but offers the following additional functionality.
- New filtered files can be created from existing files.
- 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).
- Entry data can be accessed as RandomAccessData.
Author:

Phillip Webb

Field Summary

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

Fields inherited from class java.util.jar.JarFile
MANIFEST_NAME

Fields inherited from class java.util.zip.ZipFile
OPEN_DELETE, OPEN_READ

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`Enumeration<JarEntry>`	`entries()`
`ZipEntry`	`getEntry(String name)`
`JarFile`	`getFilteredJarFile(JarEntryFilter... filters)` Return a new jar based on the filtered contents of this file.
`InputStream`	`getInputStream(ZipEntry ze)`
`JarEntry`	`getJarEntry(String name)`
`JarEntryData`	`getJarEntryData(AsciiBytes name)`
`JarEntryData`	`getJarEntryData(String name)`
`Manifest`	`getManifest()`
`String`	`getName()`
`JarFile`	`getNestedJarFile(JarEntryData sourceEntry)` Return a nested `JarFile` loaded from the specified entry.
`JarFile`	`getNestedJarFile(ZipEntry entry)` Return a nested `JarFile` loaded from the specified entry.
`protected RandomAccessDataFile`	`getRootJarFile()`
`URL`	`getUrl()` Return a URL that can be used to access this JAR file.
`Iterator<JarEntryData>`	`iterator()`
`static void`	`registerUrlProtocolHandler()` Register a 'java.protocol.handler.pkgs' property so that a `URLStreamHandler` will be located to deal with jar URLs.
`int`	`size()`
`String`	`toString()`

Methods inherited from class java.util.jar.JarFile
stream

Methods inherited from class java.util.zip.ZipFile
finalize, getComment

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - LOCSIG
```
public static final long LOCSIG
```
    See Also:
    
    Constant Field Values
  - EXTSIG
```
public static final long EXTSIG
```
    See Also:
    
    Constant Field Values
  - CENSIG
```
public static final long CENSIG
```
    See Also:
    
    Constant Field Values
  - ENDSIG
```
public static final long ENDSIG
```
    See Also:
    
    Constant Field Values
  - LOCHDR
```
public static final int LOCHDR
```
    See Also:
    
    Constant Field Values
  - EXTHDR
```
public static final int EXTHDR
```
    See Also:
    
    Constant Field Values
  - CENHDR
```
public static final int CENHDR
```
    See Also:
    
    Constant Field Values
  - ENDHDR
```
public static final int ENDHDR
```
    See Also:
    
    Constant Field Values
  - LOCVER
```
public static final int LOCVER
```
    See Also:
    
    Constant Field Values
  - LOCFLG
```
public static final int LOCFLG
```
    See Also:
    
    Constant Field Values
  - LOCHOW
```
public static final int LOCHOW
```
    See Also:
    
    Constant Field Values
  - LOCTIM
```
public static final int LOCTIM
```
    See Also:
    
    Constant Field Values
  - LOCCRC
```
public static final int LOCCRC
```
    See Also:
    
    Constant Field Values
  - LOCSIZ
```
public static final int LOCSIZ
```
    See Also:
    
    Constant Field Values
  - LOCLEN
```
public static final int LOCLEN
```
    See Also:
    
    Constant Field Values
  - LOCNAM
```
public static final int LOCNAM
```
    See Also:
    
    Constant Field Values
  - LOCEXT
```
public static final int LOCEXT
```
    See Also:
    
    Constant Field Values
  - EXTCRC
```
public static final int EXTCRC
```
    See Also:
    
    Constant Field Values
  - EXTSIZ
```
public static final int EXTSIZ
```
    See Also:
    
    Constant Field Values
  - EXTLEN
```
public static final int EXTLEN
```
    See Also:
    
    Constant Field Values
  - CENVEM
```
public static final int CENVEM
```
    See Also:
    
    Constant Field Values
  - CENVER
```
public static final int CENVER
```
    See Also:
    
    Constant Field Values
  - CENFLG
```
public static final int CENFLG
```
    See Also:
    
    Constant Field Values
  - CENHOW
```
public static final int CENHOW
```
    See Also:
    
    Constant Field Values
  - CENTIM
```
public static final int CENTIM
```
    See Also:
    
    Constant Field Values
  - CENCRC
```
public static final int CENCRC
```
    See Also:
    
    Constant Field Values
  - CENSIZ
```
public static final int CENSIZ
```
    See Also:
    
    Constant Field Values
  - CENLEN
```
public static final int CENLEN
```
    See Also:
    
    Constant Field Values
  - CENNAM
```
public static final int CENNAM
```
    See Also:
    
    Constant Field Values
  - CENEXT
```
public static final int CENEXT
```
    See Also:
    
    Constant Field Values
  - CENCOM
```
public static final int CENCOM
```
    See Also:
    
    Constant Field Values
  - CENDSK
```
public static final int CENDSK
```
    See Also:
    
    Constant Field Values
  - CENATT
```
public static final int CENATT
```
    See Also:
    
    Constant Field Values
  - CENATX
```
public static final int CENATX
```
    See Also:
    
    Constant Field Values
  - CENOFF
```
public static final int CENOFF
```
    See Also:
    
    Constant Field Values
  - ENDSUB
```
public static final int ENDSUB
```
    See Also:
    
    Constant Field Values
  - ENDTOT
```
public static final int ENDTOT
```
    See Also:
    
    Constant Field Values
  - ENDSIZ
```
public static final int ENDSIZ
```
    See Also:
    
    Constant Field Values
  - ENDOFF
```
public static final int ENDOFF
```
    See Also:
    
    Constant Field Values
  - ENDCOM
```
public static final int ENDCOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - 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 Detail
  - 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
  - iterator
```
public Iterator<JarEntryData> iterator()
```
    Specified by:
    
    iterator in interface Iterable<JarEntryData>
  - getJarEntry
```
public JarEntry getJarEntry(String name)
```
    Overrides:
    
    getJarEntry in class JarFile
  - getEntry
```
public ZipEntry getEntry(String name)
```
    Overrides:
    
    getEntry in class JarFile
  - getJarEntryData
```
public JarEntryData getJarEntryData(String name)
```
  - getJarEntryData
```
public JarEntryData getJarEntryData(AsciiBytes name)
```
  - getInputStream
```
public InputStream getInputStream(ZipEntry ze)
                           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(JarEntryData sourceEntry)
                         throws IOException
```
    Return a nested JarFile loaded from the specified entry.
    
    Parameters:
    
    sourceEntry - the zip entry
    
    Returns:
    
    a JarFile for the entry
    
    Throws:
    
    IOException - if the nested jar file cannot be read
  - getFilteredJarFile
```
public JarFile getFilteredJarFile(JarEntryFilter... filters)
                           throws IOException
```
    Return a new jar based on the filtered contents of this file.
    
    Parameters:
    
    filters - the set of jar entry filters to be applied
    
    Returns:
    
    a filtered JarFile
    
    Throws:
    
    IOException - if the jar file cannot be read
  - size
```
public int size()
```
    Overrides:
    
    size in class ZipFile
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class ZipFile
    
    Throws:
    
    IOException
  - getUrl
```
public URL getUrl()
           throws MalformedURLException
```
    Return a URL that can be used to access this JAR file. NOTE: the specified URL cannot be serialized and or cloned.
    
    Returns:
    
    the URL
    
    Throws:
    
    MalformedURLException - if the URL is malformed
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class ZipFile
  - registerUrlProtocolHandler
```
public static void registerUrlProtocolHandler()
```
    Register a 'java.protocol.handler.pkgs' property so that a URLStreamHandler will be located to deal with jar URLs.

Class JarFile

Field Summary

Fields inherited from class java.util.jar.JarFile

Fields inherited from class java.util.zip.ZipFile

Constructor Summary

Method Summary

Methods inherited from class java.util.jar.JarFile

Methods inherited from class java.util.zip.ZipFile

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

LOCSIG

EXTSIG

CENSIG

ENDSIG

LOCHDR

EXTHDR

CENHDR

ENDHDR

LOCVER

LOCFLG

LOCHOW

LOCTIM

LOCCRC

LOCSIZ

LOCLEN

LOCNAM

LOCEXT

EXTCRC

EXTSIZ

EXTLEN

CENVEM

CENVER

CENFLG

CENHOW

CENTIM

CENCRC

CENSIZ

CENLEN

CENNAM

CENEXT

CENCOM

CENDSK

CENATT

CENATX

CENOFF

ENDSUB

ENDTOT

ENDSIZ

ENDOFF

ENDCOM

Constructor Detail

JarFile

Method Detail

getRootJarFile

getManifest

entries

iterator

getJarEntry

getEntry

getJarEntryData

getJarEntryData

getInputStream

getNestedJarFile

getNestedJarFile

getFilteredJarFile

size

close

getUrl

toString

getName

registerUrlProtocolHandler