[commons-bcel] 03/03: Javadoc use of ClassNotFoundException

[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 d6caf2df0d8be01195bc3500594480682e53badc
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Wed Nov 16 10:39:21 2022 -0500

    Javadoc use of ClassNotFoundException
---
 src/main/java/org/apache/bcel/util/JavaWrapper.java  | 1 +
 src/main/java/org/apache/bcel/util/Repository.java   | 6 +++++-
 src/main/java/org/apache/bcel/verifier/Verifier.java | 2 ++
 3 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/bcel/util/JavaWrapper.java 
b/src/main/java/org/apache/bcel/util/JavaWrapper.java
index c55afb61..38ebf189 100644
--- a/src/main/java/org/apache/bcel/util/JavaWrapper.java
+++ b/src/main/java/org/apache/bcel/util/JavaWrapper.java
@@ -87,6 +87,7 @@ public class JavaWrapper {
      *
      * @param className the fully qualified class name
      * @param argv the arguments just as you would pass them directly
+     * @throws ClassNotFoundException if {@code className} can't be found.
      */
     public void runMain(final String className, final String[] argv) throws 
ClassNotFoundException {
         final Class<?> cl = loader.loadClass(className);
diff --git a/src/main/java/org/apache/bcel/util/Repository.java 
b/src/main/java/org/apache/bcel/util/Repository.java
index 9407955c..89a28b71 100644
--- a/src/main/java/org/apache/bcel/util/Repository.java
+++ b/src/main/java/org/apache/bcel/util/Repository.java
@@ -42,12 +42,16 @@ public interface Repository {
     ClassPath getClassPath();
 
     /**
-     * Finds the JavaClass instance for the given run-time class object
+     * Finds the JavaClass instance for the given run-time class object.
+     *
+     * @throws ClassNotFoundException if the class can't be found.
      */
     JavaClass loadClass(Class<?> clazz) throws ClassNotFoundException;
 
     /**
      * Finds the class with the name provided, if the class isn't there, make 
an attempt to load it.
+     *
+     * @throws ClassNotFoundException if the class can't be found.
      */
     JavaClass loadClass(String className) throws ClassNotFoundException;
 
diff --git a/src/main/java/org/apache/bcel/verifier/Verifier.java 
b/src/main/java/org/apache/bcel/verifier/Verifier.java
index 84de3859..97392a68 100644
--- a/src/main/java/org/apache/bcel/verifier/Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/Verifier.java
@@ -191,6 +191,8 @@ public class Verifier {
     /**
      * This returns all the (warning) messages collected during verification. 
A prefix shows from which verifying pass a
      * message originates.
+     *
+     * @throws ClassNotFoundException if this class can't be found.
      */
     public String[] getMessages() throws ClassNotFoundException {
         final List<String> messages = new ArrayList<>();