Jar (Apache Tomcat 7.0.67 API Documentation)

All Known Implementing Classes:

FileUrlJar, UrlJar
```
public interface Jar
```
Provides an abstraction for use by the various classes that need to scan JARs. The classes provided by the JRE for accessing JARs (JarFile and JarInputStream) have significantly different performance characteristics depending on the form of the URL used to access the JAR. For file based JAR URLs, JarFile is faster but for non-file based URLs, JarFile creates a copy of the JAR in the temporary directory so JarInputStream is faster.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close any resources associated with this JAR.
`boolean`	`entryExists(java.lang.String name)` Determines if a specific entry exists within the JAR.
`java.io.InputStream`	`getEntryInputStream()` Obtains the input stream for the current entry.
`java.lang.String`	`getEntryName()` Obtains the name of the current entry.
`java.io.InputStream`	`getInputStream(java.lang.String name)` Obtain an `InputStream` for a given entry in a JAR.
`void`	`nextEntry()` Moves the internal pointer to the next entry in the JAR.
`void`	`reset()` Resets the internal pointer used to track JAR entries to the beginning of the JAR.

- Method Detail
  - entryExists
```
boolean entryExists(java.lang.String name)
                    throws java.io.IOException
```
    Determines if a specific entry exists within the JAR.
    
    Parameters:
    name - Entry to look for
    
    Returns:
    true if the specified entry exists else false
    
    Throws:
    
    java.io.IOException
  - getInputStream
```
java.io.InputStream getInputStream(java.lang.String name)
                                   throws java.io.IOException
```
    Obtain an InputStream for a given entry in a JAR. The caller is responsible for closing the stream.
    
    Parameters:
    name - Entry to obtain an InputStream for
    
    Returns:
    An InputStream for the specified entry or null if the entry does not exist
    
    Throws:
    
    java.io.IOException
  - close
```
void close()
```
    Close any resources associated with this JAR.
  - nextEntry
```
void nextEntry()
```
    Moves the internal pointer to the next entry in the JAR.
  - getEntryName
```
java.lang.String getEntryName()
```
    Obtains the name of the current entry.
    
    Returns:
    The entry name
  - getEntryInputStream
```
java.io.InputStream getEntryInputStream()
                                        throws java.io.IOException
```
    Obtains the input stream for the current entry.
    
    Returns:
    The input stream
    
    Throws:
    
    java.io.IOException - If the stream cannot be obtained
  - reset
```
void reset()
           throws java.io.IOException
```
    Resets the internal pointer used to track JAR entries to the beginning of the JAR.
    
    Throws:
    
    java.io.IOException - If the pointer cannot be reset

Interface Jar

Method Summary

Method Detail

entryExists

getInputStream

close

nextEntry

getEntryName

getEntryInputStream

reset