[commons-bcel] 01/04: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git

commit c2bb9264e3a930eac3fa0d74e576f330aa3596e4
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Sat Nov 19 19:27:24 2022 -0500

    Javadoc
---
 src/main/java/org/apache/bcel/util/ClassPath.java | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/src/main/java/org/apache/bcel/util/ClassPath.java 
b/src/main/java/org/apache/bcel/util/ClassPath.java
index 783a9c85..7f665ccb 100644
--- a/src/main/java/org/apache/bcel/util/ClassPath.java
+++ b/src/main/java/org/apache/bcel/util/ClassPath.java
@@ -670,6 +670,10 @@ public class ClassPath implements Closeable {
     }
 
     /**
+     * Gets an InputStream.
+     * <p>
+     * The caller is responsible for closing the InputStream.
+     * </p>
      * @param name fully qualified class name, e.g. java.lang.String
      * @return input stream for class
      * @throws IOException if an I/O error occurs.
@@ -679,24 +683,27 @@ public class ClassPath implements Closeable {
     }
 
     /**
-     * Return stream for class or resource on CLASSPATH.
+     * Gets an InputStream for a class or resource on the classpath.
+     * <p>
+     * The caller is responsible for closing the InputStream.
+     * </p>
      *
-     * @param name fully qualified file name, e.g. java/lang/String
+     * @param name   fully qualified file name, e.g. java/lang/String
      * @param suffix file name ends with suff, e.g. .java
      * @return input stream for file on class path
      * @throws IOException if an I/O error occurs.
      */
     public InputStream getInputStream(final String name, final String suffix) 
throws IOException {
-        InputStream inputStream = null;
         try {
             final java.lang.ClassLoader classLoader = 
getClass().getClassLoader();
-            inputStream = classLoader == null ? null : 
classLoader.getResourceAsStream(name + suffix); // may return null
+            @SuppressWarnings("resource") // closed by caller
+            InputStream inputStream = classLoader == null ? null : 
classLoader.getResourceAsStream(name + suffix);
+            if (inputStream != null) {
+                return inputStream;
+            }
         } catch (final Exception ignored) {
             // ignored
         }
-        if (inputStream != null) {
-            return inputStream;
-        }
         return getClassFile(name, suffix).getInputStream();
     }