You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/01/11 04:32:43 UTC
(commons-bcel) 07/09: Javadoc
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 fd0dd3c36c7b2bdfc0b8d245be11bc83e04e9ac7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jan 10 23:32:04 2026 -0500
Javadoc
---
.../org/apache/bcel/generic/FieldOrMethod.java | 26 +++++++++++++++++-----
1 file changed, 21 insertions(+), 5 deletions(-)
diff --git a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
index 1cbbc499..2c19afff 100644
--- a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
+++ b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
@@ -38,14 +38,20 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
}
/**
- * @param index to constant pool
+ * Constructs a FieldOrMethod.
+ *
+ * @param opcode the opcode.
+ * @param index to constant pool.
*/
protected FieldOrMethod(final short opcode, final int index) {
super(opcode, index);
}
/**
- * @return name of the referenced class/interface
+ * Gets the name of the referenced class/interface.
+ *
+ * @param cpg the constant pool generator.
+ * @return name of the referenced class/interface.
* @deprecated If the instruction references an array class, this method will return "java.lang.Object". For code
* generated by Java 1.5, this answer is sometimes wrong (for example, if the "clone()" method is called on an
* array). A better idea is to use the {@link #getReferenceType(ConstantPoolGen)} method, which correctly
@@ -64,7 +70,10 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
}
/**
- * @return type of the referenced class/interface
+ * Gets the type of the referenced class/interface.
+ *
+ * @param cpg the constant pool generator.
+ * @return type of the referenced class/interface.
* @deprecated If the instruction references an array class, the ObjectType returned will be invalid. Use
* getReferenceType() instead.
*/
@@ -76,8 +85,9 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
/**
* Gets the ObjectType of the method return or field.
*
- * @return type of the referenced class/interface
- * @throws ClassGenException when the field is (or method returns) an array,
+ * @param cpg the constant pool generator.
+ * @return type of the referenced class/interface.
+ * @throws ClassGenException when the field is (or method returns) an array.
*/
@Override
public ObjectType getLoadClassType(final ConstantPoolGen cpg) {
@@ -92,6 +102,9 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
}
/**
+ * Gets the name of referenced method or field.
+ *
+ * @param cpg the constant pool generator.
* @return name of referenced method/field.
*/
public String getName(final ConstantPoolGen cpg) {
@@ -120,6 +133,9 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
}
/**
+ * Gets the signature of referenced method or field.
+ *
+ * @param cpg the constant pool generator.
* @return signature of referenced method/field.
*/
public String getSignature(final ConstantPoolGen cpg) {