svn commit: r1681700 - /tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java

[ma...@apache.org]

Author: markt
Date: Tue May 26 07:53:35 2015
New Revision: 1681700

URL: http://svn.apache.org/r1681700
Log:
Javadoc

Modified:
    tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java

Modified: tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java?rev=1681700&r1=1681699&r2=1681700&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/util/scan/Jar.java Tue May 26 07:53:35 2015
@@ -32,7 +32,7 @@ import java.net.URL;
 public interface Jar extends AutoCloseable {
 
     /**
-     * Obtain the URL for accessing the JAR file.
+     * @return The URL for accessing the JAR file.
      */
     URL getJarFileURL();
 
@@ -42,6 +42,9 @@ public interface Jar extends AutoCloseab
      * @param name  Entry to look for
      * @return      <code>true</code> if the specified entry exists else
      *               <code>false</code>
+     *
+     * @throws IOException if an I/O error occurs while processing the JAR file
+     *   entries
      */
     boolean entryExists(String name) throws IOException;
 
@@ -53,6 +56,8 @@ public interface Jar extends AutoCloseab
      * @param name  Entry to obtain an {@link InputStream} for
      * @return      An {@link InputStream} for the specified entry or null if
      *              the entry does not exist
+     *
+     * @throws IOException if an I/O error occurs while processing the JAR file
      */
     InputStream getInputStream(String name) throws IOException;
 
@@ -64,6 +69,8 @@ public interface Jar extends AutoCloseab
      * @return The time (in the same format as
      *         {@link System#currentTimeMillis()} that the resource was last
      *         modified. Returns -1 if the entry does not exist
+     *
+     * @throws IOException if an I/O error occurs while processing the JAR file
      */
     long getLastModified(String name) throws IOException;
 



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org