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
The following commit(s) were added to refs/heads/master by this push:
new 9b73400f Javadoc
new 12b695ae Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-bcel.git
9b73400f is described below
commit 9b73400fc275888d741c33e7b9c379b45caca286
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Fri Nov 18 15:18:56 2022 -0500
Javadoc
---
src/main/java/org/apache/bcel/generic/LoadClass.java | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/bcel/generic/LoadClass.java
b/src/main/java/org/apache/bcel/generic/LoadClass.java
index cc21bae6..438cb5b1 100644
--- a/src/main/java/org/apache/bcel/generic/LoadClass.java
+++ b/src/main/java/org/apache/bcel/generic/LoadClass.java
@@ -17,24 +17,26 @@
package org.apache.bcel.generic;
/**
- * Denotes that an instruction may start the process of loading and resolving
the referenced class in the Virtual
- * Machine.
+ * Denotes that an instruction may start the process of loading and resolving
the referenced class in the Virtual Machine.
*/
public interface LoadClass {
/**
- * Returns the ObjectType of the referenced class or interface that may be
loaded and resolved.
+ * Returns the {@link ObjectType} of the referenced class or interface
that may be loaded and resolved.
*
+ * @param cpg A ConstantPoolGen
* @return object type that may be loaded or null if a primitive is
referenced
*/
ObjectType getLoadClassType(ConstantPoolGen cpg);
/**
- * Returns the type associated with this instruction. LoadClass instances
are always typed, but this type does not
- * always refer to the type of the class or interface that it possibly
forces to load. For example, GETFIELD would
- * return the type of the field and not the type of the class where the
field is defined. If no class is forced to be
- * loaded, <B>null</B> is returned. An example for this is an ANEWARRAY
instruction that creates an int[][].
+ * Returns the type associated with this instruction. LoadClass instances
are always typed, but this type does not always refer to the type of the class
or
+ * interface that it possibly forces to load. For example, {@link
GETFIELD} would return the type of the field and not the type of the class
where the field
+ * is defined. If no class is forced to be loaded, {@code null} is
returned. An example for this is an {@link NEWARRAY} instruction that creates an
+ * {@code int[][]}.
*
+ * @param cpg A ConstantPoolGen
+ * @return the type associated with this instruction.
* @see #getLoadClassType(ConstantPoolGen)
*/
Type getType(ConstantPoolGen cpg);
