This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 a6d4655d Javadoc
a6d4655d is described below
commit a6d4655d0e39a2aff7e7bb78eb5161e53696911e
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Sep 5 07:11:36 2026 -0400
Javadoc
---
src/main/java/org/apache/bcel/Repository.java | 28 +++++++++++-----------
.../org/apache/bcel/classfile/ClassParser.java | 18 +++++++-------
src/main/java/org/apache/bcel/classfile/Code.java | 6 ++---
.../java/org/apache/bcel/classfile/Constant.java | 2 +-
.../org/apache/bcel/classfile/ConstantPool.java | 16 ++++++-------
.../java/org/apache/bcel/classfile/JavaClass.java | 14 +++++------
.../java/org/apache/bcel/classfile/Method.java | 2 +-
.../org/apache/bcel/classfile/MethodParameter.java | 2 +-
.../java/org/apache/bcel/classfile/Utility.java | 20 ++++++++--------
.../org/apache/bcel/generic/CPInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/DCONST.java | 2 +-
.../org/apache/bcel/generic/FieldOrMethod.java | 2 +-
src/main/java/org/apache/bcel/generic/IINC.java | 4 ++--
.../java/org/apache/bcel/generic/Instruction.java | 2 +-
.../org/apache/bcel/generic/InstructionList.java | 8 +++----
.../apache/bcel/generic/InstructionTargeter.java | 2 +-
.../org/apache/bcel/generic/InvokeInstruction.java | 2 +-
.../bcel/generic/LocalVariableInstruction.java | 2 +-
.../java/org/apache/bcel/generic/ObjectType.java | 8 +++----
src/main/java/org/apache/bcel/generic/RET.java | 2 +-
.../org/apache/bcel/generic/ReferenceType.java | 8 +++----
.../bcel/util/AbstractClassPathRepository.java | 4 ++--
src/main/java/org/apache/bcel/util/Args.java | 4 ++--
src/main/java/org/apache/bcel/util/BCELifier.java | 2 +-
src/main/java/org/apache/bcel/util/Class2HTML.java | 2 +-
.../java/org/apache/bcel/util/JavaWrapper.java | 2 +-
.../org/apache/bcel/util/ModularRuntimeImage.java | 10 ++++----
src/main/java/org/apache/bcel/util/Repository.java | 4 ++--
.../java/org/apache/bcel/verifier/Verifier.java | 2 +-
.../bcel/verifier/statics/LocalVariableInfo.java | 2 +-
.../bcel/verifier/statics/LocalVariablesInfo.java | 2 +-
.../bcel/verifier/statics/Pass2Verifier.java | 7 +++---
.../bcel/verifier/statics/Pass3aVerifier.java | 8 +++----
.../structurals/InstConstraintVisitor.java | 8 +++----
.../bcel/verifier/structurals/Pass3bVerifier.java | 2 +-
.../bcel/verifier/structurals/Subroutines.java | 4 ++--
.../apache/bcel/verifier/VerifyBadClassesTest.java | 2 +-
37 files changed, 108 insertions(+), 109 deletions(-)
diff --git a/src/main/java/org/apache/bcel/Repository.java
b/src/main/java/org/apache/bcel/Repository.java
index 44e734c2..9109c90b 100644
--- a/src/main/java/org/apache/bcel/Repository.java
+++ b/src/main/java/org/apache/bcel/Repository.java
@@ -60,7 +60,7 @@ public abstract class Repository {
* @param clazz The class.
* @return all interfaces implemented by class and its super classes and
the interfaces that those interfaces extend,
* and so on. (Some people call this a transitive hull).
- * @throws ClassNotFoundException if any of the class's superclasses or
superinterfaces can't be found.
+ * @throws ClassNotFoundException Thrown if any of the class's
superclasses or superinterfaces can't be found.
*/
public static JavaClass[] getInterfaces(final JavaClass clazz) throws
ClassNotFoundException {
return clazz.getAllInterfaces();
@@ -72,7 +72,7 @@ public abstract class Repository {
* @param className The class name.
* @return all interfaces implemented by class and its super classes and
the interfaces that extend those interfaces,
* and so on.
- * @throws ClassNotFoundException if the named class can't be found, or if
any of its superclasses or superinterfaces
+ * @throws ClassNotFoundException Thrown if the named class can't be
found, or if any of its superclasses or superinterfaces
* can't be found.
*/
public static JavaClass[] getInterfaces(final String className) throws
ClassNotFoundException {
@@ -93,7 +93,7 @@ public abstract class Repository {
*
* @param clazz The class.
* @return list of super classes of clazz in ascending order, that is,
Object is always the last element.
- * @throws ClassNotFoundException if any of the superclasses can't be
found.
+ * @throws ClassNotFoundException Thrown if any of the superclasses can't
be found.
*/
public static JavaClass[] getSuperClasses(final JavaClass clazz) throws
ClassNotFoundException {
return clazz.getSuperClasses();
@@ -104,7 +104,7 @@ public abstract class Repository {
*
* @param className The class name.
* @return list of super classes of clazz in ascending order, that is,
Object is always the last element.
- * @throws ClassNotFoundException if the named class or any of its
superclasses can't be found.
+ * @throws ClassNotFoundException Thrown if the named class or any of its
superclasses can't be found.
*/
public static JavaClass[] getSuperClasses(final String className) throws
ClassNotFoundException {
return getSuperClasses(lookupClass(className));
@@ -116,7 +116,7 @@ public abstract class Repository {
* @param clazz The class to test.
* @param inter The interface.
* @return true, if clazz is an implementation of interface inter.
- * @throws ClassNotFoundException if any superclasses or superinterfaces
of clazz can't be found.
+ * @throws ClassNotFoundException Thrown if any superclasses or
superinterfaces of clazz can't be found.
*/
public static boolean implementationOf(final JavaClass clazz, final
JavaClass inter) throws ClassNotFoundException {
return clazz.implementationOf(inter);
@@ -128,7 +128,7 @@ public abstract class Repository {
* @param clazz The class to test.
* @param inter The interface name.
* @return true, if clazz is an implementation of interface inter.
- * @throws ClassNotFoundException if inter or any superclasses or
superinterfaces of clazz can't be found.
+ * @throws ClassNotFoundException Thrown if inter or any superclasses or
superinterfaces of clazz can't be found.
*/
public static boolean implementationOf(final JavaClass clazz, final String
inter) throws ClassNotFoundException {
return implementationOf(clazz, lookupClass(inter));
@@ -140,7 +140,7 @@ public abstract class Repository {
* @param clazz The class name to test.
* @param inter The interface.
* @return true, if clazz is an implementation of interface inter.
- * @throws ClassNotFoundException if clazz or any superclasses or
superinterfaces of clazz can't be found.
+ * @throws ClassNotFoundException Thrown if clazz or any superclasses or
superinterfaces of clazz can't be found.
*/
public static boolean implementationOf(final String clazz, final JavaClass
inter) throws ClassNotFoundException {
return implementationOf(lookupClass(clazz), inter);
@@ -152,7 +152,7 @@ public abstract class Repository {
* @param clazz The class name to test.
* @param inter The interface name.
* @return true, if clazz is an implementation of interface inter.
- * @throws ClassNotFoundException if clazz, inter, or any superclasses or
superinterfaces of clazz can't be found.
+ * @throws ClassNotFoundException Thrown if clazz, inter, or any
superclasses or superinterfaces of clazz can't be found.
*/
public static boolean implementationOf(final String clazz, final String
inter) throws ClassNotFoundException {
return implementationOf(lookupClass(clazz), lookupClass(inter));
@@ -164,7 +164,7 @@ public abstract class Repository {
* @param clazz The class to test.
* @param superclass The superclass.
* @return true, if clazz is an instance of superclass.
- * @throws ClassNotFoundException if any superclasses or superinterfaces
of clazz can't be found.
+ * @throws ClassNotFoundException Thrown if any superclasses or
superinterfaces of clazz can't be found.
*/
public static boolean instanceOf(final JavaClass clazz, final JavaClass
superclass) throws ClassNotFoundException {
return clazz.instanceOf(superclass);
@@ -176,7 +176,7 @@ public abstract class Repository {
* @param clazz The class to test.
* @param superclass The superclass name.
* @return true, if clazz is an instance of superclass.
- * @throws ClassNotFoundException if superclass can't be found.
+ * @throws ClassNotFoundException Thrown if superclass can't be found.
*/
public static boolean instanceOf(final JavaClass clazz, final String
superclass) throws ClassNotFoundException {
return instanceOf(clazz, lookupClass(superclass));
@@ -188,7 +188,7 @@ public abstract class Repository {
* @param clazz The class name to test.
* @param superclass The superclass.
* @return true, if clazz is an instance of superclass.
- * @throws ClassNotFoundException if clazz can't be found.
+ * @throws ClassNotFoundException Thrown if clazz can't be found.
*/
public static boolean instanceOf(final String clazz, final JavaClass
superclass) throws ClassNotFoundException {
return instanceOf(lookupClass(clazz), superclass);
@@ -200,7 +200,7 @@ public abstract class Repository {
* @param clazz The class name to test.
* @param superclass The superclass name.
* @return true, if clazz is an instance of superclass.
- * @throws ClassNotFoundException if either clazz or superclass can't be
found.
+ * @throws ClassNotFoundException Thrown if either clazz or superclass
can't be found.
*/
public static boolean instanceOf(final String clazz, final String
superclass) throws ClassNotFoundException {
return instanceOf(lookupClass(clazz), lookupClass(superclass));
@@ -212,7 +212,7 @@ public abstract class Repository {
* @param clazz The class.
* @see Class
* @return JavaClass object for given runtime class.
- * @throws ClassNotFoundException if the class could not be found or
parsed correctly.
+ * @throws ClassNotFoundException Thrown if the class could not be found
or parsed correctly.
*/
public static JavaClass lookupClass(final Class<?> clazz) throws
ClassNotFoundException {
return repository.loadClass(clazz);
@@ -223,7 +223,7 @@ public abstract class Repository {
*
* @param className The class name.
* @return class object for given fully qualified class name.
- * @throws ClassNotFoundException if the class could not be found or
parsed correctly.
+ * @throws ClassNotFoundException Thrown if the class could not be found
or parsed correctly.
*/
public static JavaClass lookupClass(final String className) throws
ClassNotFoundException {
return repository.loadClass(className);
diff --git a/src/main/java/org/apache/bcel/classfile/ClassParser.java
b/src/main/java/org/apache/bcel/classfile/ClassParser.java
index c3fad688..ecd68957 100644
--- a/src/main/java/org/apache/bcel/classfile/ClassParser.java
+++ b/src/main/java/org/apache/bcel/classfile/ClassParser.java
@@ -118,7 +118,7 @@ public final class ClassParser {
*
* @return Class object representing the parsed class file.
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
public JavaClass parse() throws IOException, ClassFormatException {
ZipFile zip = null;
@@ -186,7 +186,7 @@ public final class ClassParser {
* Reads information about the attributes of the class.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readAttributes() throws IOException, ClassFormatException {
final int attributesCount = dataInputStream.readUnsignedShort();
@@ -200,7 +200,7 @@ public final class ClassParser {
* Reads information about the class and its super class.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readClassInfo() throws IOException, ClassFormatException {
accessFlags = dataInputStream.readUnsignedShort();
@@ -221,7 +221,7 @@ public final class ClassParser {
* Reads constant pool entries.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readConstantPool() throws IOException, ClassFormatException {
constantPool = new ConstantPool(dataInputStream);
@@ -231,7 +231,7 @@ public final class ClassParser {
* Reads information about the fields of the class, that is, its variables.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readFields() throws IOException, ClassFormatException {
final int fieldsCount = dataInputStream.readUnsignedShort();
@@ -245,7 +245,7 @@ public final class ClassParser {
* Checks whether the header of the file is ok. Of course, this has to be
the first action on successive file reads.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readID() throws IOException, ClassFormatException {
if (dataInputStream.readInt() != Const.JVM_CLASSFILE_MAGIC) {
@@ -257,7 +257,7 @@ public final class ClassParser {
* Reads information about the interfaces implemented by this class.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readInterfaces() throws IOException, ClassFormatException {
interfaces = readU2U2Table(dataInputStream);
@@ -267,7 +267,7 @@ public final class ClassParser {
* Reads information about the methods of the class.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readMethods() throws IOException {
final int methodsCount = dataInputStream.readUnsignedShort();
@@ -281,7 +281,7 @@ public final class ClassParser {
* Reads major and minor version of compiler which created the file.
*
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
private void readVersion() throws IOException, ClassFormatException {
minor = dataInputStream.readUnsignedShort();
diff --git a/src/main/java/org/apache/bcel/classfile/Code.java
b/src/main/java/org/apache/bcel/classfile/Code.java
index d6a71557..c027ac91 100644
--- a/src/main/java/org/apache/bcel/classfile/Code.java
+++ b/src/main/java/org/apache/bcel/classfile/Code.java
@@ -87,7 +87,7 @@ public final class Code extends Attribute {
* @param length Content length in bytes.
* @param dataInput Data input.
* @param constantPool Array of constants.
- * @throws ClassFormatException if the code array read from {@code file}
is greater than {@link Const#MAX_CODE_SIZE}.
+ * @throws ClassFormatException Thrown if the code array read from {@code
file} is greater than {@link Const#MAX_CODE_SIZE}.
*/
Code(final int nameIndex, final int length, final DataInput dataInput,
final ConstantPool constantPool) throws IOException {
// Initialize with some default values which will be overwritten later
@@ -130,7 +130,7 @@ public final class Code extends Attribute {
* @param exceptionTable of handled exceptions.
* @param attributes Attributes of code: LineNumber or LocalVariable.
* @param constantPool Array of constants.
- * @throws ClassFormatException if the code array is greater than {@link
Const#MAX_CODE_SIZE}.
+ * @throws ClassFormatException Thrown if the code array is greater than
{@link Const#MAX_CODE_SIZE}.
*/
public Code(final int nameIndex, final int length, final int maxStack,
final int maxLocals, final byte[] code, final CodeException[] exceptionTable,
final Attribute[] attributes, final ConstantPool constantPool) {
@@ -344,7 +344,7 @@ public final class Code extends Attribute {
* Sets the byte code.
*
* @param code byte code.
- * @throws ClassFormatException if the code array is greater than {@link
Const#MAX_CODE_SIZE}.
+ * @throws ClassFormatException Thrown if the code array is greater than
{@link Const#MAX_CODE_SIZE}.
*/
public void setCode(final byte[] code) {
this.code = ArrayUtils.nullToEmpty(code);
diff --git a/src/main/java/org/apache/bcel/classfile/Constant.java
b/src/main/java/org/apache/bcel/classfile/Constant.java
index 6d3c47b6..c3b1b4a8 100644
--- a/src/main/java/org/apache/bcel/classfile/Constant.java
+++ b/src/main/java/org/apache/bcel/classfile/Constant.java
@@ -62,7 +62,7 @@ public abstract class Constant implements Cloneable, Node {
* @param dataInput Input stream.
* @return Constant object.
* @throws IOException Thrown if an I/O error occurs reading from the
given {@code dataInput}.
- * @throws ClassFormatException if the next byte is not recognized
+ * @throws ClassFormatException Thrown if the next byte is not recognized
* @since 6.0 made public
*/
public static Constant readConstant(final DataInput dataInput) throws
IOException, ClassFormatException {
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantPool.java
b/src/main/java/org/apache/bcel/classfile/ConstantPool.java
index 6a62dc2f..51ce05e2 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantPool.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantPool.java
@@ -120,7 +120,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
*
* @param c Constant to be printed.
* @return String representation.
- * @throws IllegalArgumentException if c is unknown constant type.
+ * @throws IllegalArgumentException Thrown if c is unknown constant type.
*/
public String constantToString(Constant c) throws IllegalArgumentException
{
final String str;
@@ -267,7 +267,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
* @param index Index in constant pool.
* @return Constant value.
* @see Constant
- * @throws ClassFormatException if index is invalid.
+ * @throws ClassFormatException Thrown if index is invalid.
*/
@SuppressWarnings("unchecked")
public <T extends Constant> T getConstant(final int index) throws
ClassFormatException {
@@ -282,7 +282,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
* @param tag Tag of expected constant, that is, its type.
* @return Constant value.
* @see Constant
- * @throws ClassFormatException if constant type does not match tag.
+ * @throws ClassFormatException Thrown if constant type does not match tag.
*/
@SuppressWarnings("unchecked")
public <T extends Constant> T getConstant(final int index, final byte tag)
throws ClassFormatException {
@@ -298,7 +298,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
* @param castTo The class to cast to.
* @return Constant value.
* @see Constant
- * @throws ClassFormatException if constant type does not match tag.
+ * @throws ClassFormatException Thrown if constant type does not match tag.
* @since 6.6.0
*/
public <T extends Constant> T getConstant(final int index, final byte tag,
final Class<T> castTo) throws ClassFormatException {
@@ -316,7 +316,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
* @param index Index in constant pool.
* @param castTo The {@link Constant} subclass to cast to.
* @return Constant value.
- * @throws ClassFormatException if index is invalid.
+ * @throws ClassFormatException Thrown if index is invalid.
* @see Constant
* @since 6.6.0
*/
@@ -348,7 +348,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
*
* @param index Index in constant pool.
* @return ConstantInteger value.
- * @throws ClassFormatException if constant type does not match tag.
+ * @throws ClassFormatException Thrown if constant type does not match tag.
* @see ConstantInteger
*/
public ConstantInteger getConstantInteger(final int index) {
@@ -372,7 +372,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
* @param index Index in constant pool.
* @param tag Tag of expected constant, either ConstantClass or
ConstantString.
* @return Contents of string reference.
- * @throws IllegalArgumentException if tag is invalid.
+ * @throws IllegalArgumentException Thrown if tag is invalid.
* @see ConstantClass
* @see ConstantString
*/
@@ -410,7 +410,7 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
*
* @param index Index in constant pool.
* @return ConstantUtf8 value.
- * @throws ClassFormatException if constant type does not match tag.
+ * @throws ClassFormatException Thrown if constant type does not match tag.
* @see ConstantUtf8
*/
public ConstantUtf8 getConstantUtf8(final int index) throws
ClassFormatException {
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java
b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index 7a45489d..36217dba 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -428,7 +428,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* @param fieldName The field name to find.
* @param fieldType The field type to find.
* @return field matching given name and type, null if field is not found
or not accessible from this class.
- * @throws ClassNotFoundException if the class cannot be found.
+ * @throws ClassNotFoundException Thrown if the class cannot be found.
* @since 6.8.0
*/
public Field findField(final String fieldName, final Type fieldType)
throws ClassNotFoundException {
@@ -475,7 +475,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* Gets all interfaces implemented by this JavaClass (transitively).
*
* @return all interfaces.
- * @throws ClassNotFoundException if any of the class's superclasses or
interfaces can't be found.
+ * @throws ClassNotFoundException Thrown if any of the class's
superclasses or interfaces can't be found.
*/
public JavaClass[] getAllInterfaces() throws ClassNotFoundException {
final ClassQueue queue = new ClassQueue();
@@ -626,7 +626,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* Gets interfaces directly implemented by this JavaClass.
*
* @return The interfaces.
- * @throws ClassNotFoundException if any of the class's interfaces can't
be found.
+ * @throws ClassNotFoundException Thrown if any of the class's interfaces
can't be found.
*/
public JavaClass[] getInterfaces() throws ClassNotFoundException {
final String[] interfaces = getInterfaceNames();
@@ -736,7 +736,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* Gets the superclass for this JavaClass object, or null if this is
{@link Object}.
*
* @return The superclass for this JavaClass object, or null if this is
{@link Object}.
- * @throws ClassNotFoundException if the superclass can't be found.
+ * @throws ClassNotFoundException Thrown if the superclass can't be found.
*/
public JavaClass getSuperClass() throws ClassNotFoundException {
if (CLASS_NAME_OBJECT.equals(getClassName())) {
@@ -749,7 +749,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* Gets list of super classes of this class in ascending order.
*
* @return list of super classes of this class in ascending order, that
is, {@link Object} is always the last element.
- * @throws ClassNotFoundException if any of the superclasses can't be
found.
+ * @throws ClassNotFoundException Thrown if any of the superclasses can't
be found.
*/
public JavaClass[] getSuperClasses() throws ClassNotFoundException {
JavaClass clazz = this;
@@ -799,7 +799,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
*
* @param inter The interface to check.
* @return true, if this class is an implementation of interface inter.
- * @throws ClassNotFoundException if superclasses or superinterfaces of
this class can't be found.
+ * @throws ClassNotFoundException Thrown if superclasses or
superinterfaces of this class can't be found.
*/
public boolean implementationOf(final JavaClass inter) throws
ClassNotFoundException {
if (!inter.isInterface()) {
@@ -822,7 +822,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
*
* @param superclass The superclass to check.
* @return true if this JavaClass is derived from the super class.
- * @throws ClassNotFoundException if superclasses or superinterfaces of
this object can't be found.
+ * @throws ClassNotFoundException Thrown if superclasses or
superinterfaces of this object can't be found.
*/
public final boolean instanceOf(final JavaClass superclass) throws
ClassNotFoundException {
if (equals(superclass)) {
diff --git a/src/main/java/org/apache/bcel/classfile/Method.java
b/src/main/java/org/apache/bcel/classfile/Method.java
index 31ccf4eb..79a999e8 100644
--- a/src/main/java/org/apache/bcel/classfile/Method.java
+++ b/src/main/java/org/apache/bcel/classfile/Method.java
@@ -83,7 +83,7 @@ public final class Method extends FieldOrMethod {
*
* @param file Input stream.
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file.
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file.
*/
Method(final DataInput file, final ConstantPool constantPool) throws
IOException, ClassFormatException {
super(file, constantPool);
diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameter.java
b/src/main/java/org/apache/bcel/classfile/MethodParameter.java
index c03c7317..56bb5aa2 100644
--- a/src/main/java/org/apache/bcel/classfile/MethodParameter.java
+++ b/src/main/java/org/apache/bcel/classfile/MethodParameter.java
@@ -54,7 +54,7 @@ public class MethodParameter implements Cloneable, Node {
*
* @param input Input stream.
* @throws IOException Thrown if an I/O error occurs.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
MethodParameter(final DataInput input) throws IOException {
nameIndex = input.readUnsignedShort();
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java
b/src/main/java/org/apache/bcel/classfile/Utility.java
index f9e65231..e3b00655 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -925,7 +925,7 @@ public abstract class Utility {
*
* @param signature Method signature.
* @return String Array of argument types.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
public static String[] methodSignatureArgumentTypes(final String
signature) throws ClassFormatException {
return methodSignatureArgumentTypes(signature, true);
@@ -937,7 +937,7 @@ public abstract class Utility {
* @param signature Method signature.
* @param chopit flag that determines whether chopping is executed or not.
* @return String Array of argument types.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
public static String[] methodSignatureArgumentTypes(final String
signature, final boolean chopit) throws ClassFormatException {
final List<String> vec = new ArrayList<>();
@@ -964,7 +964,7 @@ public abstract class Utility {
*
* @param signature Method signature.
* @return String representation of method return type.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
public static String methodSignatureReturnType(final String signature)
throws ClassFormatException {
return methodSignatureReturnType(signature, true);
@@ -976,7 +976,7 @@ public abstract class Utility {
* @param signature Method signature.
* @param chopit flag that determines whether chopping is executed or not.
* @return String representation of method return type.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
public static String methodSignatureReturnType(final String signature,
final boolean chopit) throws ClassFormatException {
try {
@@ -1026,7 +1026,7 @@ public abstract class Utility {
* @param chopit flag that determines whether chopping is executed or not.
* @param vars The LocalVariableTable for the method.
* @return Java type declaration.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
*/
public static String methodSignatureToString(final String signature, final
String name, final String access, final boolean chopit,
final LocalVariableTable vars) throws ClassFormatException {
@@ -1081,7 +1081,7 @@ public abstract class Utility {
* @param ret Return type of method.
* @param argv Types of method arguments.
* @return Byte code representation of method signature.
- * @throws ClassFormatException if the signature is for Void
+ * @throws ClassFormatException Thrown if the signature is for Void
*/
public static String methodTypeToSignature(final String ret, final
String[] argv) throws ClassFormatException {
final StringBuilder buf = new StringBuilder("(");
@@ -1347,7 +1347,7 @@ public abstract class Utility {
* @param signature in format described above.
* @return type of method signature.
* @see Const
- * @throws ClassFormatException if signature is not a method signature
+ * @throws ClassFormatException Thrown if signature is not a method
signature
*/
public static byte typeOfMethodSignature(final String signature) throws
ClassFormatException {
try {
@@ -1367,7 +1367,7 @@ public abstract class Utility {
* @param signature in format described above.
* @return type of signature.
* @see Const
- * @throws ClassFormatException if signature isn't a known type
+ * @throws ClassFormatException Thrown if signature isn't a known type
*/
public static byte typeOfSignature(final String signature) throws
ClassFormatException {
try {
@@ -1498,7 +1498,7 @@ public abstract class Utility {
* @param signature type signature.
* @param chopit flag that determines whether chopping is executed or not.
* @return string containing human readable type signature.
- * @throws ClassFormatException if a class is malformed or cannot be
interpreted as a class file
+ * @throws ClassFormatException Thrown if a class is malformed or cannot
be interpreted as a class file
* @since 6.4.0
*/
public static String typeSignatureToString(final String signature, final
boolean chopit) throws ClassFormatException {
@@ -1512,7 +1512,7 @@ public abstract class Utility {
* @param chopit flag that determines whether chopping is executed or
not.
* @param depth current nesting depth.
* @return string containing human readable type signature.
- * @throws ClassFormatException if the signature is malformed or nested
deeper than {@code MAX_SIGNATURE_NESTING}.
+ * @throws ClassFormatException Thrown if the signature is malformed or
nested deeper than {@code MAX_SIGNATURE_NESTING}.
*/
private static String typeSignatureToString(final String signature, final
boolean chopit, final int depth) throws ClassFormatException {
if (depth > MAX_SIGNATURE_NESTING) {
diff --git a/src/main/java/org/apache/bcel/generic/CPInstruction.java
b/src/main/java/org/apache/bcel/generic/CPInstruction.java
index 6e13dead..d317061f 100644
--- a/src/main/java/org/apache/bcel/generic/CPInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/CPInstruction.java
@@ -108,7 +108,7 @@ public abstract class CPInstruction extends Instruction
implements TypedInstruct
* Sets the index to constant pool.
*
* @param index in constant pool.
- * @throws ClassGenException if index is out of bounds.
+ * @throws ClassGenException Thrown if index is out of bounds.
*/
@Override
public void setIndex(final int index) { // TODO could be package-protected?
diff --git a/src/main/java/org/apache/bcel/generic/DCONST.java
b/src/main/java/org/apache/bcel/generic/DCONST.java
index bebde253..30101184 100644
--- a/src/main/java/org/apache/bcel/generic/DCONST.java
+++ b/src/main/java/org/apache/bcel/generic/DCONST.java
@@ -40,7 +40,7 @@ public class DCONST extends Instruction implements
ConstantPushInstruction {
* Constructs a DCONST instruction.
*
* @param f The constant value (must be 0.0 or 1.0).
- * @throws ClassGenException if f is not 0.0 or 1.0.
+ * @throws ClassGenException Thrown if f is not 0.0 or 1.0.
*/
public DCONST(final double f) {
super(org.apache.bcel.Const.DCONST_0, (short) 1);
diff --git a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
index b55d84e8..1327e061 100644
--- a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
+++ b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
@@ -87,7 +87,7 @@ public abstract class FieldOrMethod extends CPInstruction
implements LoadClass {
*
* @param cpg The constant pool generator.
* @return type of the referenced class/interface.
- * @throws ClassGenException when the field is (or method returns) an
array.
+ * @throws ClassGenException Thrown when the field is (or method returns)
an array.
*/
@Override
public ObjectType getLoadClassType(final ConstantPoolGen cpg) {
diff --git a/src/main/java/org/apache/bcel/generic/IINC.java
b/src/main/java/org/apache/bcel/generic/IINC.java
index 9b2c0d34..251b5b9a 100644
--- a/src/main/java/org/apache/bcel/generic/IINC.java
+++ b/src/main/java/org/apache/bcel/generic/IINC.java
@@ -124,7 +124,7 @@ public class IINC extends LocalVariableInstruction {
* Sets increment factor.
*
* @param c The increment factor.
- * @throws ClassGenException if the increment is out of bounds.
+ * @throws ClassGenException Thrown if the increment is out of bounds.
*/
public final void setIncrement(final int c) {
if (!isValidShort(c)) {
@@ -138,7 +138,7 @@ public class IINC extends LocalVariableInstruction {
* Sets index of local variable.
*
* @param index index of local variable.
- * @throws ClassGenException if index is out of bounds.
+ * @throws ClassGenException Thrown if index is out of bounds.
*/
@Override
public final void setIndex(final int index) {
diff --git a/src/main/java/org/apache/bcel/generic/Instruction.java
b/src/main/java/org/apache/bcel/generic/Instruction.java
index fa6c71e7..54d856f5 100644
--- a/src/main/java/org/apache/bcel/generic/Instruction.java
+++ b/src/main/java/org/apache/bcel/generic/Instruction.java
@@ -585,7 +585,7 @@ public abstract class Instruction implements Cloneable {
*
* @param bytes byte sequence to read from.
* @param wide "wide" instruction flag.
- * @throws IOException may be thrown if the implementation needs to read
data from the file
+ * @throws IOException Thrown if the implementation needs to read data
from the file
*/
@SuppressWarnings("unused") // thrown by subclasses
protected void initFromFile(final ByteSequence bytes, final boolean wide)
throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index c70157db..86fc1d23 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -468,7 +468,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
* Remove instruction from this list. The corresponding Instruction
handles must not be reused!
*
* @param i instruction to remove.
- * @throws TargetLostException if target is lost.
+ * @throws TargetLostException Thrown if target is lost.
*/
public void delete(final Instruction i) throws TargetLostException {
final InstructionHandle ih;
@@ -484,7 +484,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
*
* @param from where to start deleting (inclusive).
* @param to where to end deleting (inclusive).
- * @throws TargetLostException if target is lost.
+ * @throws TargetLostException Thrown if target is lost.
*/
public void delete(final Instruction from, final Instruction to) throws
TargetLostException {
final InstructionHandle fromIh;
@@ -502,7 +502,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
* Remove instruction from this list. The corresponding Instruction
handles must not be reused!
*
* @param ih instruction (handle) to remove.
- * @throws TargetLostException if target is lost.
+ * @throws TargetLostException Thrown if target is lost.
*/
public void delete(final InstructionHandle ih) throws TargetLostException {
remove(ih.getPrev(), ih.getNext());
@@ -514,7 +514,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
*
* @param from where to start deleting (inclusive).
* @param to where to end deleting (inclusive).
- * @throws TargetLostException if target is lost.
+ * @throws TargetLostException Thrown if target is lost.
*/
public void delete(final InstructionHandle from, final InstructionHandle
to) throws TargetLostException {
remove(from.getPrev(), to.getNext());
diff --git a/src/main/java/org/apache/bcel/generic/InstructionTargeter.java
b/src/main/java/org/apache/bcel/generic/InstructionTargeter.java
index 29a9ae67..d4bafa99 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionTargeter.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionTargeter.java
@@ -43,7 +43,7 @@ public interface InstructionTargeter {
*
* @param oldIh The old handle.
* @param newIh The new handle.
- * @throws ClassGenException if oldIh is not targeted by this object
+ * @throws ClassGenException Thrown if oldIh is not targeted by this object
*/
void updateTarget(InstructionHandle oldIh, InstructionHandle newIh) throws
ClassGenException;
}
diff --git a/src/main/java/org/apache/bcel/generic/InvokeInstruction.java
b/src/main/java/org/apache/bcel/generic/InvokeInstruction.java
index 6714eeb1..ab70d9c4 100644
--- a/src/main/java/org/apache/bcel/generic/InvokeInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/InvokeInstruction.java
@@ -80,7 +80,7 @@ public abstract class InvokeInstruction extends FieldOrMethod
implements Excepti
* This overrides the deprecated version as we know here that the
referenced class may legally be an array.
*
* @return name of the referenced class/interface.
- * @throws IllegalArgumentException if the referenced class is an array
(this should not happen)
+ * @throws IllegalArgumentException Thrown if the referenced class is an
array (this should not happen)
*/
@Override
public String getClassName(final ConstantPoolGen cpg) {
diff --git
a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
index 48ee24fb..e518acea 100644
--- a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
@@ -167,7 +167,7 @@ public abstract class LocalVariableInstruction extends
Instruction implements Ty
* Sets the local variable index. also updates opcode and length TODO Why?
*
* @param index local variable index (unsigned short).
- * @throws ClassGenException if index is out of bounds.
+ * @throws ClassGenException Thrown if index is out of bounds.
* @see #setIndexOnly(int)
*/
@Override
diff --git a/src/main/java/org/apache/bcel/generic/ObjectType.java
b/src/main/java/org/apache/bcel/generic/ObjectType.java
index 452e3cef..bd598f25 100644
--- a/src/main/java/org/apache/bcel/generic/ObjectType.java
+++ b/src/main/java/org/apache/bcel/generic/ObjectType.java
@@ -56,7 +56,7 @@ public class ObjectType extends ReferenceType {
*
* @param accessor The accessing type.
* @return true if accessible.
- * @throws ClassNotFoundException if the class referenced by this type
can't be found.
+ * @throws ClassNotFoundException Thrown if the class referenced by this
type can't be found.
*/
public boolean accessibleTo(final ObjectType accessor) throws
ClassNotFoundException {
final JavaClass jc = Repository.lookupClass(className);
@@ -114,7 +114,7 @@ public class ObjectType extends ReferenceType {
* Return true if this type references a class, false if it references an
interface.
*
* @return true if the type references a class, false if it references an
interface.
- * @throws ClassNotFoundException if the class or interface referenced by
this type can't be found
+ * @throws ClassNotFoundException Thrown if the class or interface
referenced by this type can't be found
*/
public boolean referencesClassExact() throws ClassNotFoundException {
final JavaClass jc = Repository.lookupClass(className);
@@ -142,7 +142,7 @@ public class ObjectType extends ReferenceType {
* Return true if this type references an interface, false if it
references a class.
*
* @return true if the type references an interface, false if it
references a class.
- * @throws ClassNotFoundException if the class or interface referenced by
this type can't be found
+ * @throws ClassNotFoundException Thrown if the class or interface
referenced by this type can't be found
*/
public boolean referencesInterfaceExact() throws ClassNotFoundException {
final JavaClass jc = Repository.lookupClass(className);
@@ -154,7 +154,7 @@ public class ObjectType extends ReferenceType {
*
* @param superclass The superclass to check against.
* @return true if this is a subclass.
- * @throws ClassNotFoundException if any of this class's superclasses
can't be found.
+ * @throws ClassNotFoundException Thrown if any of this class's
superclasses can't be found.
*/
public boolean subclassOf(final ObjectType superclass) throws
ClassNotFoundException {
if (referencesInterfaceExact() ||
superclass.referencesInterfaceExact()) {
diff --git a/src/main/java/org/apache/bcel/generic/RET.java
b/src/main/java/org/apache/bcel/generic/RET.java
index 783be93a..cd2e848c 100644
--- a/src/main/java/org/apache/bcel/generic/RET.java
+++ b/src/main/java/org/apache/bcel/generic/RET.java
@@ -116,7 +116,7 @@ public class RET extends Instruction implements
IndexedInstruction, TypedInstruc
* Sets index of local variable containg the return address
*
* @param index index of local variable containg the return address.
- * @throws ClassGenException if index is out of bounds.
+ * @throws ClassGenException Thrown if index is out of bounds.
*/
@Override
public final void setIndex(final int index) {
diff --git a/src/main/java/org/apache/bcel/generic/ReferenceType.java
b/src/main/java/org/apache/bcel/generic/ReferenceType.java
index 425062b3..74b2e9aa 100644
--- a/src/main/java/org/apache/bcel/generic/ReferenceType.java
+++ b/src/main/java/org/apache/bcel/generic/ReferenceType.java
@@ -54,7 +54,7 @@ public abstract class ReferenceType extends Type {
*
* @param t The other type.
* @return The first common superclass.
- * @throws ClassNotFoundException on failure to find superclasses of this
type, or the type passed as a parameter.
+ * @throws ClassNotFoundException Thrown on failure to find superclasses
of this type, or the type passed as a parameter.
* @deprecated Use getFirstCommonSuperclass(ReferenceType t) which has
slightly changed semantics.
*/
@Deprecated
@@ -89,7 +89,7 @@ public abstract class ReferenceType extends Type {
*
* @param t The other type.
* @return The first common superclass.
- * @throws ClassNotFoundException on failure to find superclasses of this
type, or the type passed as a parameter.
+ * @throws ClassNotFoundException Thrown on failure to find superclasses
of this type, or the type passed as a parameter.
*/
public ReferenceType getFirstCommonSuperclass(final ReferenceType t)
throws ClassNotFoundException {
if (equals(NULL)) {
@@ -160,7 +160,7 @@ public abstract class ReferenceType extends Type {
*
* @param t The other type.
* @return true iff this is assignment compatible with another type t.
- * @throws ClassNotFoundException if any classes or interfaces required to
determine assignment compatibility can't be
+ * @throws ClassNotFoundException Thrown if any classes or interfaces
required to determine assignment compatibility can't be
* found.
*/
public boolean isAssignmentCompatibleWith(final Type t) throws
ClassNotFoundException {
@@ -261,7 +261,7 @@ public abstract class ReferenceType extends Type {
*
* @param t The other type.
* @return true iff this type is castable to another type t.
- * @throws ClassNotFoundException if any classes or interfaces required to
determine assignment compatibility can't be
+ * @throws ClassNotFoundException Thrown if any classes or interfaces
required to determine assignment compatibility can't be
* found.
*/
public boolean isCastableTo(final Type t) throws ClassNotFoundException {
diff --git
a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
index 429c156a..787b1a9d 100644
--- a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
@@ -62,7 +62,7 @@ abstract class AbstractClassPathRepository implements
Repository {
* @see Class
* @param clazz The runtime Class object.
* @return JavaClass object for given runtime class.
- * @throws ClassNotFoundException if the class is not in the Repository,
and its representation could not be found
+ * @throws ClassNotFoundException Thrown if the class is not in the
Repository, and its representation could not be found
*/
@Override
public JavaClass loadClass(final Class<?> clazz) throws
ClassNotFoundException {
@@ -110,7 +110,7 @@ abstract class AbstractClassPathRepository implements
Repository {
*
* @param className The name of the class.
* @return The JavaClass object.
- * @throws ClassNotFoundException if the class is not in the Repository,
and could not be found on the classpath
+ * @throws ClassNotFoundException Thrown if the class is not in the
Repository, and could not be found on the classpath
*/
@Override
public JavaClass loadClass(String className) throws ClassNotFoundException
{
diff --git a/src/main/java/org/apache/bcel/util/Args.java
b/src/main/java/org/apache/bcel/util/Args.java
index aa470244..25d45e11 100644
--- a/src/main/java/org/apache/bcel/util/Args.java
+++ b/src/main/java/org/apache/bcel/util/Args.java
@@ -122,8 +122,8 @@ public class Args {
* @param max The maximum required u4 value.
* @param message The message prefix.
* @return The value to test.
- * @throws IllegalArgumentException if {@code min < 0} or {@code max >
Integer.MAX_VALUE}.
- * @throws ClassFormatException if {@code value < min} or {@code value
> max}.
+ * @throws IllegalArgumentException Thrown if {@code min < 0} or {@code
max > Integer.MAX_VALUE}.
+ * @throws ClassFormatException Thrown if {@code value < min} or
{@code value > max}.
* @since 6.12.0
*/
public static int requireU4(final int value, final int min, final int max,
final String message) {
diff --git a/src/main/java/org/apache/bcel/util/BCELifier.java
b/src/main/java/org/apache/bcel/util/BCELifier.java
index a40c8a94..392f60bf 100644
--- a/src/main/java/org/apache/bcel/util/BCELifier.java
+++ b/src/main/java/org/apache/bcel/util/BCELifier.java
@@ -79,7 +79,7 @@ public class BCELifier extends
org.apache.bcel.classfile.EmptyVisitor {
*
* @param name the class or package name to check.
* @return {@code name} if it is safe to emit as a Java identifier.
- * @throws IllegalArgumentException if the name is not a dotted sequence
of valid Java identifiers.
+ * @throws IllegalArgumentException Thrown if the name is not a dotted
sequence of valid Java identifiers.
*/
private static String checkJavaName(final String name) {
boolean expectStart = true;
diff --git a/src/main/java/org/apache/bcel/util/Class2HTML.java
b/src/main/java/org/apache/bcel/util/Class2HTML.java
index bb3e252e..bdc484e3 100644
--- a/src/main/java/org/apache/bcel/util/Class2HTML.java
+++ b/src/main/java/org/apache/bcel/util/Class2HTML.java
@@ -78,7 +78,7 @@ public class Class2HTML implements Constants {
* let a crafted class file write its HTML output outside the target
directory (CWE-22).
*
* @param name the class name about to be used as part of a file name.
- * @throws IOException if the name contains a path separator, a
Windows-reserved file name character, a
+ * @throws IOException Thrown if the name contains a path separator, a
Windows-reserved file name character, a
* control character, or a ".." sequence.
*/
private static void checkFileNameSafe(final String name) throws
IOException {
diff --git a/src/main/java/org/apache/bcel/util/JavaWrapper.java
b/src/main/java/org/apache/bcel/util/JavaWrapper.java
index 7ddfab0e..08dafa83 100644
--- a/src/main/java/org/apache/bcel/util/JavaWrapper.java
+++ b/src/main/java/org/apache/bcel/util/JavaWrapper.java
@@ -100,7 +100,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.
+ * @throws ClassNotFoundException Thrown 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/ModularRuntimeImage.java
b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
index 21b88d4d..cf27ff52 100644
--- a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
+++ b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
@@ -62,7 +62,7 @@ public class ModularRuntimeImage implements Closeable {
* Constructs an instance using the JRT file system implementation from a
specific Java Home.
*
* @param javaHome Path to a Java 9 or greater home.
- * @throws IOException an I/O error occurs accessing the file system
+ * @throws IOException Thrown if I/O error occurs accessing the file
system.
*/
public ModularRuntimeImage(final String javaHome) throws IOException {
final Map<String, ?> emptyMap = Collections.emptyMap();
@@ -103,7 +103,7 @@ public class ModularRuntimeImage implements Closeable {
*
* @param dirPath directory path.
* @return A list of dir entries if an I/O error occurs.
- * @throws IOException an I/O error occurs accessing the file system
+ * @throws IOException Thrown if I/O error occurs accessing the file
system.
*/
public List<Path> list(final Path dirPath) throws IOException {
final List<Path> list = new ArrayList<>();
@@ -118,7 +118,7 @@ public class ModularRuntimeImage implements Closeable {
*
* @param dirName directory path.
* @return A list of dir entries if an I/O error occurs.
- * @throws IOException an I/O error occurs accessing the file system
+ * @throws IOException Thrown if I/O error occurs accessing the file
system.
*/
public List<Path> list(final String dirName) throws IOException {
return list(fileSystem.getPath(dirName));
@@ -128,7 +128,7 @@ public class ModularRuntimeImage implements Closeable {
* Lists all modules.
*
* @return A list of modules.
- * @throws IOException an I/O error occurs accessing the file system
+ * @throws IOException Thrown if I/O error occurs accessing the file
system.
*/
public List<Path> modules() throws IOException {
return list(MODULES_PATH);
@@ -138,7 +138,7 @@ public class ModularRuntimeImage implements Closeable {
* Lists all packages.
*
* @return A list of modules.
- * @throws IOException an I/O error occurs accessing the file system
+ * @throws IOException Thrown if I/O error occurs accessing the file
system.
*/
public List<Path> packages() throws IOException {
return list(PACKAGES_PATH);
diff --git a/src/main/java/org/apache/bcel/util/Repository.java
b/src/main/java/org/apache/bcel/util/Repository.java
index 909630bb..5c1b7f08 100644
--- a/src/main/java/org/apache/bcel/util/Repository.java
+++ b/src/main/java/org/apache/bcel/util/Repository.java
@@ -53,7 +53,7 @@ public interface Repository {
*
* @param clazz The class.
* @return The JavaClass instance.
- * @throws ClassNotFoundException if the class can't be found.
+ * @throws ClassNotFoundException Thrown if the class can't be found.
*/
JavaClass loadClass(Class<?> clazz) throws ClassNotFoundException;
@@ -62,7 +62,7 @@ public interface Repository {
*
* @param className The class name.
* @return The JavaClass instance.
- * @throws ClassNotFoundException if the class can't be found.
+ * @throws ClassNotFoundException Thrown 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 6a874a81..a6146650 100644
--- a/src/main/java/org/apache/bcel/verifier/Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/Verifier.java
@@ -206,7 +206,7 @@ public class Verifier {
* message originates.
*
* @return The array of messages.
- * @throws ClassNotFoundException if this class can't be found.
+ * @throws ClassNotFoundException Thrown if this class can't be found.
*/
public String[] getMessages() throws ClassNotFoundException {
final List<String> messages = new ArrayList<>();
diff --git
a/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
b/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
index 15cea256..614eecd7 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
@@ -71,7 +71,7 @@ public class LocalVariableInfo {
* @param startPc Range in which the variable is valid.
* @param length length of ...
* @param type variable type.
- * @throws LocalVariableInfoInconsistentException if the new information
conflicts with already gathered information.
+ * @throws LocalVariableInfoInconsistentException Thrown if the new
information conflicts with already gathered information.
*/
public void add(final String name, final int startPc, final int length,
final Type type) throws LocalVariableInfoInconsistentException {
final int endPc = startPc + length; // incl/incl-notation!
diff --git
a/src/main/java/org/apache/bcel/verifier/statics/LocalVariablesInfo.java
b/src/main/java/org/apache/bcel/verifier/statics/LocalVariablesInfo.java
index 040fcf39..86d7ef4c 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/LocalVariablesInfo.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/LocalVariablesInfo.java
@@ -47,7 +47,7 @@ public class LocalVariablesInfo {
* @param startPc Range in which the variable is valid.
* @param length length of ...
* @param type variable type.
- * @throws LocalVariableInfoInconsistentException if the new information
conflicts with already gathered information.
+ * @throws LocalVariableInfoInconsistentException Thrown if the new
information conflicts with already gathered information.
*/
public void add(final int slot, final String name, final int startPc,
final int length, final Type type) throws
LocalVariableInfoInconsistentException {
// The add operation on LocalVariableInfo may throw the
'...Inconsistent...' exception, we don't throw it explicitly
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
index 1826a5bb..6c92f6b2 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
@@ -1276,7 +1276,7 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
* Ensures that the constant pool entries satisfy the static constraints
as described in The Java Virtual Machine
* Specification, 2nd Edition.
*
- * @throws ClassConstraintException otherwise.
+ * @throws AssertionViolatedException Thrown if the class is missing.
*/
private void constantPoolEntriesSatisfyStaticConstraints() {
try {
@@ -1393,7 +1393,7 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
* otherwise. <B>Precondition: index-style cross referencing in the
constant pool must be valid. Simply invoke
* constant_pool_entries_satisfy_static_constraints() before.</B>
*
- * @throws ClassConstraintException otherwise.
+ * @throws AssertionViolatedException Thrown if the class is missing.
* @see #constantPoolEntriesSatisfyStaticConstraints()
*/
private void fieldAndMethodRefsAreValid() {
@@ -1401,7 +1401,6 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
final JavaClass jc =
Repository.lookupClass(verifier.getClassName());
final DescendingVisitor v = new DescendingVisitor(jc, new
FAMRAV_Visitor(jc));
v.visit();
-
} catch (final ClassNotFoundException e) {
// FIXME: this might not be the best way to handle missing classes.
throw new AssertionViolatedException("Missing class: " + e, e);
@@ -1413,7 +1412,7 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
* constant_pool_entries_satisfy_static_constraints() and
every_class_has_an_accessible_superclass() have to be invoked
* before (in that order).</B>
*
- * @throws ClassConstraintException otherwise.
+ * @throws AssertionViolatedException Thrown if the class is missing.
* @see #constantPoolEntriesSatisfyStaticConstraints()
* @see #everyClassHasAnAccessibleSuperclass()
*/
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
index 4d3853bd..2806fe3a 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
@@ -903,7 +903,7 @@ public final class Pass3aVerifier extends PassVerifier {
* checks need access to the code array of the Code attribute of a Method
so it's okay to perform them here. Also see
* the description of the do_verify() method.
*
- * @throws ClassConstraintException if the verification fails.
+ * @throws ClassConstraintException Thrown if the verification fails.
* @see #do_verify()
*/
private void delayedPass2Checks() {
@@ -1006,7 +1006,7 @@ public final class Pass3aVerifier extends PassVerifier {
* LocalVariableTable attribute of a Code attribute is delayed until this
pass. All these checks need access to the code
* array of the Code attribute.
*
- * @throws InvalidMethodException if the method to verify does not exist.
+ * @throws InvalidMethodException Thrown if the method to verify does not
exist.
*/
@Override
public VerificationResult do_verify() {
@@ -1083,7 +1083,7 @@ public final class Pass3aVerifier extends PassVerifier {
* These are the checks if constraints are satisfied which are described
in the Java Virtual Machine Specification,
* Second Edition as Static Constraints on the instructions of Java
Virtual Machine Code (chapter 4.8.1).
*
- * @throws StaticCodeConstraintException if the verification fails.
+ * @throws StaticCodeConstraintException Thrown if the verification fails.
*/
private void pass3StaticInstructionChecks() {
@@ -1145,7 +1145,7 @@ public final class Pass3aVerifier extends PassVerifier {
* (chapter 4.8.1). BCEL parses the code array to create an
InstructionList and therefore has to check some of these
* constraints. Additional checks are also implemented here.
*
- * @throws StaticCodeConstraintException if the verification fails.
+ * @throws StaticCodeConstraintException Thrown if the verification fails.
*/
private void pass3StaticInstructionOperandsChecks() {
try {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
b/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
index d50f902e..7504ec99 100644
---
a/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
+++
b/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
@@ -260,7 +260,7 @@ public class InstConstraintVisitor extends EmptyVisitor {
/**
* Assures arrayref is of ArrayType or NULL; returns true if and only if
arrayref is non-NULL.
*
- * @throws StructuralCodeConstraintException if the above constraint is
violated.
+ * @throws StructuralCodeConstraintException Thrown if the above
constraint is violated.
*/
private boolean arrayrefOfArrayType(final Instruction o, final Type
arrayref) {
if (!(arrayref instanceof ArrayType || arrayref.equals(Type.NULL))) {
@@ -308,7 +308,7 @@ public class InstConstraintVisitor extends EmptyVisitor {
* This method is called by the visitXXX() to notify the acceptor of this
InstConstraintVisitor that a constraint
* violation has occurred. This is done by throwing an instance of a
StructuralCodeConstraintException.
*
- * @throws StructuralCodeConstraintException always.
+ * @throws StructuralCodeConstraintException Always thrown.
*/
private void constraintViolated(final Instruction violator, final String
description) {
final String fqClassName = violator.getClass().getName();
@@ -328,7 +328,7 @@ public class InstConstraintVisitor extends EmptyVisitor {
/**
* Assures index is of type INT.
*
- * @throws StructuralCodeConstraintException if the above constraint is
not satisfied.
+ * @throws StructuralCodeConstraintException Thrown if the above
constraint is not satisfied.
*/
private void indexOfInt(final Instruction o, final Type index) {
if (!index.equals(Type.INT)) {
@@ -349,7 +349,7 @@ public class InstConstraintVisitor extends EmptyVisitor {
* Assures the ReferenceType r is initialized (or Type.NULL). Formally,
this means (!(r instanceof
* UninitializedObjectType)), because there are no uninitialized array
types.
*
- * @throws StructuralCodeConstraintException if the above constraint is
not satisfied.
+ * @throws StructuralCodeConstraintException Thrown if the above
constraint is not satisfied.
*/
private void referenceTypeIsInitialized(final Instruction o, final
ReferenceType r) {
if (r instanceof UninitializedObjectType) {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
b/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
index 0b6b7a0d..712de0fc 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
@@ -447,7 +447,7 @@ public final class Pass3bVerifier extends PassVerifier {
*
* @param returnedType The type of the returned expression.
* @param m The method we are processing.
- * @throws StructuralCodeConstraintException always
+ * @throws StructuralCodeConstraintException Always thrown.
* @since 6.0
*/
public void invalidReturnTypeError(final Type returnedType, final
MethodGen m) {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
b/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
index 6e00db5d..32a35750 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
@@ -640,7 +640,7 @@ public class Subroutines {
* call subtree. The former implementation re-explored a subroutine once
per call path, which is exponential in the
* number of subroutines for a layered JSR call graph.
*
- * @throws StructuralCodeConstraintException if the above constraint is
not satisfied.
+ * @throws StructuralCodeConstraintException Thrown if the above
constraint is not satisfied.
*/
private void noRecursiveCalls(final Subroutine sub) {
noRecursiveCalls(sub, new BitSet(), new HashMap<>(), new HashMap<>());
@@ -654,7 +654,7 @@ public class Subroutines {
* @param validated maps every fully validated subroutine to the compact
ids of the RET local variables used by it and its entire call subtree.
* @param localIds maps a RET local variable index to a compact id so the
bit sets stay small.
* @return the compact ids of the RET local variables used by {@code
sub}'s callees and their call subtrees.
- * @throws StructuralCodeConstraintException if a subroutine calls a
subroutine using the same RET local variable.
+ * @throws StructuralCodeConstraintException Thrown if a subroutine calls
a subroutine using the same RET local variable.
*/
private BitSet noRecursiveCalls(final Subroutine sub, final BitSet
pathLocals, final Map<Subroutine, BitSet> validated,
final Map<Integer, Integer> localIds) {
diff --git a/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
b/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
index cdafba3e..c340b04c 100644
--- a/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
+++ b/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
@@ -66,7 +66,7 @@ class VerifyBadClassesTest {
*
* @param command The command to be run in the process.
* @return A String capturing the error output of executing the command.
- * @throws ExecuteException if executor fails
+ * @throws ExecuteException Thrown if executor fails
* @throws IOException Thrown if executor fails
*/
private String run(final List<String> command) throws ExecuteException,
IOException {
