Package org.apache.tomcat.util.scan
Class ReferenceCountedJar
- java.lang.Object
-
- org.apache.tomcat.util.scan.ReferenceCountedJar
-
-
Constructor Summary
Constructors Constructor Description ReferenceCountedJar(java.net.URL url)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Close any resources associated with this JAR.boolean
exists(java.lang.String name)
Determine if the given resource in present in 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 anInputStream
for a given entry in a JAR.java.net.URL
getJarFileURL()
long
getLastModified(java.lang.String name)
Obtain the last modified time for the given resource in the JAR.java.util.jar.Manifest
getManifest()
Obtain the manifest for the JAR file.java.lang.String
getURL(java.lang.String entry)
Obtain, in String form, the URL for an entry in this 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
-
close
public void close()
Description copied from interface:Jar
Close any resources associated with this JAR.
-
getJarFileURL
public java.net.URL getJarFileURL()
- Specified by:
getJarFileURL
in interfaceJar
- Returns:
- The URL for accessing the JAR file.
-
getInputStream
public java.io.InputStream getInputStream(java.lang.String name) throws java.io.IOException
Description copied from interface:Jar
Obtain anInputStream
for a given entry in a JAR. The caller is responsible for closing the stream.- Specified by:
getInputStream
in interfaceJar
- Parameters:
name
- Entry to obtain anInputStream
for- Returns:
- An
InputStream
for the specified entry or null if the entry does not exist - Throws:
java.io.IOException
- if an I/O error occurs while processing the JAR file
-
getLastModified
public long getLastModified(java.lang.String name) throws java.io.IOException
Description copied from interface:Jar
Obtain the last modified time for the given resource in the JAR.- Specified by:
getLastModified
in interfaceJar
- Parameters:
name
- Entry to obtain the modification time for- Returns:
- The time (in the same format as
System.currentTimeMillis()
that the resource was last modified. Returns -1 if the entry does not exist - Throws:
java.io.IOException
- if an I/O error occurs while processing the JAR file
-
exists
public boolean exists(java.lang.String name) throws java.io.IOException
Description copied from interface:Jar
Determine if the given resource in present in the JAR.
-
nextEntry
public void nextEntry()
Description copied from interface:Jar
Moves the internal pointer to the next entry in the JAR.
-
getEntryName
public java.lang.String getEntryName()
Description copied from interface:Jar
Obtains the name of the current entry.- Specified by:
getEntryName
in interfaceJar
- Returns:
- The entry name
-
getEntryInputStream
public java.io.InputStream getEntryInputStream() throws java.io.IOException
Description copied from interface:Jar
Obtains the input stream for the current entry.- Specified by:
getEntryInputStream
in interfaceJar
- Returns:
- The input stream
- Throws:
java.io.IOException
- If the stream cannot be obtained
-
getURL
public java.lang.String getURL(java.lang.String entry)
Description copied from interface:Jar
Obtain, in String form, the URL for an entry in this JAR. Note that for JARs nested in WAR files, the Tomcat specific war:file:... form will not be used, rather the jar:jar:file:... form (that the JRE does not understand will be used). Note that this means that any code using these URLs will need to understand the jar:jar:file:... form and use theJarFactory
to ensure resources are accessed correctly.
-
getManifest
public java.util.jar.Manifest getManifest() throws java.io.IOException
Description copied from interface:Jar
Obtain the manifest for the JAR file.- Specified by:
getManifest
in interfaceJar
- Returns:
- The manifest for this JAR file.
- Throws:
java.io.IOException
- If an I/O error occurs trying to obtain the manifest
-
-