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 56c571bf5124b7c0007b3298a770e167c16cb53a Author: Gary Gregory <[email protected]> AuthorDate: Sat Jan 10 08:03:20 2026 -0500 Javadoc --- .../org/apache/bcel/classfile/ConstantClass.java | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/apache/bcel/classfile/ConstantClass.java b/src/main/java/org/apache/bcel/classfile/ConstantClass.java index 8dd5cf7b..1a594865 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantClass.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantClass.java @@ -53,6 +53,8 @@ public final class ConstantClass extends Constant implements ConstantObject { } /** + * Constructs a ConstantClass. + * * @param nameIndex Name index in constant pool. Should refer to a ConstantUtf8. */ public ConstantClass(final int nameIndex) { @@ -64,7 +66,7 @@ public final class ConstantClass extends Constant implements ConstantObject { * Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects. * - * @param v Visitor object + * @param v Visitor object. */ @Override public void accept(final Visitor v) { @@ -74,7 +76,7 @@ public final class ConstantClass extends Constant implements ConstantObject { /** * Dumps constant class to file stream in binary format. * - * @param file Output file stream + * @param file Output file stream. * @throws IOException if an I/O error occurs writing to the DataOutputStream. */ @Override @@ -84,14 +86,20 @@ public final class ConstantClass extends Constant implements ConstantObject { } /** - * @return dereferenced string + * Gets the dereferenced string. + * + * @param cp the constant pool. + * @return dereferenced string. */ public String getBytes(final ConstantPool cp) { return (String) getConstantValue(cp); } /** - * @return String object + * Gets the String object. + * + * @param cp the constant pool. + * @return String object. */ @Override public Object getConstantValue(final ConstantPool cp) { @@ -99,6 +107,8 @@ public final class ConstantClass extends Constant implements ConstantObject { } /** + * Gets the name index in constant pool of class name. + * * @return Name index in constant pool of class name. */ public int getNameIndex() { @@ -106,7 +116,9 @@ public final class ConstantClass extends Constant implements ConstantObject { } /** - * @param nameIndex the name index in the constant pool of this Constant Class + * Sets the name index in the constant pool. + * + * @param nameIndex the name index in the constant pool of this Constant Class. */ public void setNameIndex(final int nameIndex) { this.nameIndex = nameIndex;
