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 73e84275 Javadoc
73e84275 is described below
commit 73e8427517b0f5474ac340263182d25b8c0d3eef
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Jan 9 14:26:47 2026 -0500
Javadoc
---
src/examples/HelloWorldBuilder.java | 6 +--
src/examples/JasminVisitor.java | 2 +-
src/examples/Mini/ASTExpr.java | 2 +-
src/examples/Mini/ASTIfExpr.java | 2 +-
src/examples/Mini/ASTProgram.java | 2 +-
.../apache/bcel/classfile/AnnotationDefault.java | 8 ++-
.../bcel/classfile/AnnotationElementValue.java | 14 ++++++
.../org/apache/bcel/classfile/AnnotationEntry.java | 57 ++++++++++++++++++----
.../apache/bcel/classfile/ArrayElementValue.java | 2 +
.../java/org/apache/bcel/classfile/Attribute.java | 25 +++++++++-
.../apache/bcel/classfile/ClassElementValue.java | 2 +
.../org/apache/bcel/classfile/ElementValue.java | 20 +++++++-
.../apache/bcel/classfile/EnumElementValue.java | 2 +
.../bcel/classfile/LocalVariableTypeTable.java | 2 +
.../java/org/apache/bcel/classfile/Method.java | 6 +--
src/main/java/org/apache/bcel/classfile/Node.java | 5 ++
.../apache/bcel/classfile/SimpleElementValue.java | 2 +
.../java/org/apache/bcel/generic/ANEWARRAY.java | 5 ++
.../bcel/generic/AnnotationElementValueGen.java | 31 +++++++++++-
.../apache/bcel/generic/AnnotationEntryGen.java | 10 +++-
.../apache/bcel/generic/ArrayElementValueGen.java | 2 +
.../org/apache/bcel/generic/ArrayInstruction.java | 4 +-
.../org/apache/bcel/generic/CPInstruction.java | 5 +-
.../apache/bcel/generic/ClassElementValueGen.java | 2 +
.../org/apache/bcel/generic/CodeExceptionGen.java | 2 +-
.../org/apache/bcel/generic/ElementValueGen.java | 17 ++++++-
.../apache/bcel/generic/ElementValuePairGen.java | 2 +
.../apache/bcel/generic/EnumElementValueGen.java | 2 +
.../org/apache/bcel/generic/ExceptionThrower.java | 5 ++
.../java/org/apache/bcel/generic/Instruction.java | 20 ++++++--
.../apache/bcel/generic/InstructionFactory.java | 2 +-
.../org/apache/bcel/generic/InstructionList.java | 4 +-
.../org/apache/bcel/generic/LoadInstruction.java | 8 +--
.../bcel/generic/LocalVariableInstruction.java | 10 ++--
.../apache/bcel/generic/SimpleElementValueGen.java | 2 +
.../org/apache/bcel/generic/StackConsumer.java | 5 +-
.../org/apache/bcel/generic/StackProducer.java | 5 +-
.../org/apache/bcel/generic/TypedInstruction.java | 6 +++
.../java/org/apache/bcel/util/ClassLoader.java | 2 +-
src/main/java/org/apache/bcel/util/ClassPath.java | 2 +-
.../org/apache/bcel/verifier/PassVerifier.java | 2 +-
.../bcel/verifier/statics/Pass2Verifier.java | 2 +-
.../bcel/verifier/statics/Pass3aVerifier.java | 2 +-
.../verifier/structurals/ControlFlowGraph.java | 2 +-
.../bcel/verifier/structurals/LocalVariables.java | 2 +-
.../bcel/verifier/structurals/Pass3bVerifier.java | 2 +-
.../bcel/verifier/structurals/Subroutines.java | 4 +-
src/test/java/org/apache/bcel/AbstractTest.java | 2 +-
.../apache/bcel/EnclosingMethodAttributeTest.java | 2 +-
49 files changed, 275 insertions(+), 57 deletions(-)
diff --git a/src/examples/HelloWorldBuilder.java
b/src/examples/HelloWorldBuilder.java
index 90194cf7..e0e1d178 100644
--- a/src/examples/HelloWorldBuilder.java
+++ b/src/examples/HelloWorldBuilder.java
@@ -79,12 +79,12 @@ public class HelloWorldBuilder {
// Create BufferedReader object and store it in local variable 'in'.
il.append(factory.createNew("java.io.BufferedReader"));
- il.append(InstructionConst.DUP); // Use predefined constant, i.e.
flyweight
+ il.append(InstructionConst.DUP); // Use predefined constant, for
example flyweight
il.append(factory.createNew("java.io.InputStreamReader"));
il.append(InstructionConst.DUP);
il.append(factory.createFieldAccess("java.lang.System", "in", iStream,
Const.GETSTATIC));
- // Call constructors, i.e. BufferedReader(InputStreamReader())
+ // Call constructors, for example BufferedReader(InputStreamReader())
il.append(factory.createInvoke("java.io.InputStreamReader", "<init>",
Type.VOID, new Type[] {iStream}, Const.INVOKESPECIAL));
il.append(factory.createInvoke("java.io.BufferedReader", "<init>",
Type.VOID, new Type[] {new ObjectType("java.io.Reader")}, Const.INVOKESPECIAL));
@@ -147,7 +147,7 @@ public class HelloWorldBuilder {
il.dispose(); // Reuse instruction handles
- // Add public <init> method, i.e. empty constructor
+ // Add public <init> method, for example empty constructor
cg.addEmptyConstructor(Const.ACC_PUBLIC);
// Get JavaClass object and dump it to file.
diff --git a/src/examples/JasminVisitor.java b/src/examples/JasminVisitor.java
index beb99af7..8e5b70f1 100644
--- a/src/examples/JasminVisitor.java
+++ b/src/examples/JasminVisitor.java
@@ -160,7 +160,7 @@ public class JasminVisitor extends
org.apache.bcel.classfile.EmptyVisitor {
final InstructionHandle[] ihs = il.getInstructionHandles();
/*
- * Pass 1: Give all referenced instruction handles a symbolic name,
i.e. a label.
+ * Pass 1: Give all referenced instruction handles a symbolic name,
for example a label.
*/
map = new Hashtable<>();
diff --git a/src/examples/Mini/ASTExpr.java b/src/examples/Mini/ASTExpr.java
index e3dc0dba..5f67cf1a 100644
--- a/src/examples/Mini/ASTExpr.java
+++ b/src/examples/Mini/ASTExpr.java
@@ -38,7 +38,7 @@ import org.apache.bcel.generic.PUSH;
/**
* Represents arithmetic expressions such as '(a + 12 == b) OR c'. The parse
tree is built initially by the parser and
- * modified, i.e. compacted with 'traverse()'. Each (Expr, Term, Factor) node
with kind == -1 is replaced which its
+ * modified, for example compacted with 'traverse()'. Each (Expr, Term,
Factor) node with kind == -1 is replaced which its
* successor node, which is converted to type 'Expr'
*
* A node with kind == -1 denotes the fact that this expression node has just
one child branch and thus may be replaced
diff --git a/src/examples/Mini/ASTIfExpr.java b/src/examples/Mini/ASTIfExpr.java
index 224dce21..5c21133d 100644
--- a/src/examples/Mini/ASTIfExpr.java
+++ b/src/examples/Mini/ASTIfExpr.java
@@ -63,7 +63,7 @@ public class ASTIfExpr extends ASTExpr {
BranchHandle i, g;
- i = il.append(new IFEQ(null)); // If POP() == FALSE(i.e. 0) then
branch to ELSE
+ i = il.append(new IFEQ(null)); // If POP() == FALSE(for example 0)
then branch to ELSE
ASTFunDecl.pop();
il.append(then_code);
g = il.append(new GOTO(null));
diff --git a/src/examples/Mini/ASTProgram.java
b/src/examples/Mini/ASTProgram.java
index 944a6df6..93965f1f 100644
--- a/src/examples/Mini/ASTProgram.java
+++ b/src/examples/Mini/ASTProgram.java
@@ -258,7 +258,7 @@ public class ASTProgram extends SimpleNode implements
MiniParserConstants, MiniP
/**
* First pass of parse tree.
*
- * Put everything into the environment, which is copied appropriately to
each recursion level, i.e. each FunDecl gets its
+ * Put everything into the environment, which is copied appropriately to
each recursion level, for example each FunDecl gets its
* own copy that it can further manipulate.
*
* Checks for name clashes of function declarations.
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
index c1e4e346..4c64341b 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
@@ -79,14 +79,18 @@ public class AnnotationDefault extends Attribute {
}
/**
- * @return the default value
+ * Gets the default value.
+ *
+ * @return the default value.
*/
public final ElementValue getDefaultValue() {
return defaultValue;
}
/**
- * @param defaultValue the default value of this methodinfo's annotation
+ * Sets the default value of this methodinfo's annotation.
+ *
+ * @param defaultValue the default value of this methodinfo's annotation.
*/
public final void setDefaultValue(final ElementValue defaultValue) {
this.defaultValue = defaultValue;
diff --git
a/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
b/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
index 9d5aadf7..a42e4cc6 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
@@ -22,12 +22,21 @@ import java.io.DataOutputStream;
import java.io.IOException;
/**
+ * Represents an annotation element value.
+ *
* @since 6.0
*/
public class AnnotationElementValue extends ElementValue {
// For annotation element values, this is the annotation
private final AnnotationEntry annotationEntry;
+ /**
+ * Constructs an AnnotationElementValue.
+ *
+ * @param type the type.
+ * @param annotationEntry the annotation entry.
+ * @param cpool the constant pool.
+ */
public AnnotationElementValue(final int type, final AnnotationEntry
annotationEntry, final ConstantPool cpool) {
super(type, cpool);
if (type != ANNOTATION) {
@@ -42,6 +51,11 @@ public class AnnotationElementValue extends ElementValue {
annotationEntry.dump(dos);
}
+ /**
+ * Gets the annotation entry.
+ *
+ * @return the annotation entry.
+ */
public AnnotationEntry getAnnotationEntry() {
return annotationEntry;
}
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
index 72a0a94e..a657bc6e 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
@@ -43,12 +43,12 @@ public class AnnotationEntry implements Node {
}
/**
- * Factory method to create an AnnotionEntry from a DataInput
+ * Factory method to create an AnnotionEntry from a DataInput.
*
- * @param input
- * @param constantPool
- * @param isRuntimeVisible
- * @return the entry
+ * @param input the input stream.
+ * @param constantPool the constant pool.
+ * @param isRuntimeVisible whether the annotation is runtime visible.
+ * @return the entry.
* @throws IOException if an I/O error occurs.
*/
public static AnnotationEntry read(final DataInput input, final
ConstantPool constantPool, final boolean isRuntimeVisible) throws IOException {
@@ -87,10 +87,21 @@ public class AnnotationEntry implements Node {
v.visitAnnotationEntry(this);
}
+ /**
+ * Adds an element name value pair.
+ *
+ * @param elementNameValuePair the element name value pair.
+ */
public void addElementNameValuePair(final ElementValuePair
elementNameValuePair) {
elementValuePairs.add(elementNameValuePair);
}
+ /**
+ * Dumps this annotation entry to a DataOutputStream.
+ *
+ * @param dos the output stream.
+ * @throws IOException if an I/O error occurs.
+ */
public void dump(final DataOutputStream dos) throws IOException {
dos.writeShort(typeIndex); // u2 index of type name in cpool
dos.writeShort(elementValuePairs.size()); // u2 element_value pair
@@ -101,25 +112,36 @@ public class AnnotationEntry implements Node {
}
/**
- * @return the annotation type name
+ * Gets the annotation type name.
+ *
+ * @return the annotation type name.
*/
public String getAnnotationType() {
return constantPool.getConstantUtf8(typeIndex).getBytes();
}
/**
- * @return the annotation type index
+ * Gets the annotation type index.
+ *
+ * @return the annotation type index.
*/
public int getAnnotationTypeIndex() {
return typeIndex;
}
+ /**
+ * Gets the constant pool.
+ *
+ * @return the constant pool.
+ */
public ConstantPool getConstantPool() {
return constantPool;
}
/**
- * @return the element value pairs in this annotation entry
+ * Gets the element value pairs in this annotation entry.
+ *
+ * @return the element value pairs in this annotation entry.
*/
public ElementValuePair[] getElementValuePairs() {
// TODO return List
@@ -127,20 +149,37 @@ public class AnnotationEntry implements Node {
}
/**
- * @return the number of element value pairs in this annotation entry
+ * Gets the number of element value pairs in this annotation entry.
+ *
+ * @return the number of element value pairs in this annotation entry.
*/
public final int getNumElementValuePairs() {
return elementValuePairs.size();
}
+ /**
+ * Gets the type index.
+ *
+ * @return the type index.
+ */
public int getTypeIndex() {
return typeIndex;
}
+ /**
+ * Gets whether this annotation is runtime visible.
+ *
+ * @return true if this annotation is runtime visible.
+ */
public boolean isRuntimeVisible() {
return isRuntimeVisible;
}
+ /**
+ * Gets a short string representation of this annotation.
+ *
+ * @return a short string representation of this annotation.
+ */
public String toShortString() {
final StringBuilder result = new StringBuilder();
result.append("@");
diff --git a/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
b/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
index 05124c13..680a103b 100644
--- a/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
@@ -22,6 +22,8 @@ import java.io.DataOutputStream;
import java.io.IOException;
/**
+ * Represents an array element value in an annotation.
+ *
* @since 6.0
*/
public class ArrayElementValue extends ElementValue {
diff --git a/src/main/java/org/apache/bcel/classfile/Attribute.java
b/src/main/java/org/apache/bcel/classfile/Attribute.java
index f2b2e4e7..ab064fc5 100644
--- a/src/main/java/org/apache/bcel/classfile/Attribute.java
+++ b/src/main/java/org/apache/bcel/classfile/Attribute.java
@@ -90,6 +90,11 @@ public abstract class Attribute implements Cloneable, Node {
READERS.put(name, unknownAttributeReader);
}
+ /**
+ * Prints a message to stderr if debug mode is enabled.
+ *
+ * @param msg the message to print.
+ */
protected static void println(final String msg) {
if (debug) {
System.err.println(msg);
@@ -297,6 +302,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Creates a deep copy of this attribute.
+ *
* @param constantPool constant pool to save.
* @return deep copy of this attribute.
*/
@@ -314,6 +321,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Gets the constant pool used by this object.
+ *
* @return Constant pool used by this object.
* @see ConstantPool
*/
@@ -322,6 +331,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Gets the length of attribute field in bytes.
+ *
* @return Length of attribute field in bytes.
*/
public final int getLength() {
@@ -329,7 +340,9 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
- * @return Name of attribute
+ * Gets the name of attribute.
+ *
+ * @return Name of attribute.
* @since 6.0
*/
public String getName() {
@@ -337,6 +350,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Gets the name index in constant pool of attribute name.
+ *
* @return Name index in constant pool of attribute name.
*/
public final int getNameIndex() {
@@ -344,6 +359,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Gets the tag of attribute, i.e., its type.
+ *
* @return Tag of attribute, i.e., its type. Value may not be altered,
thus there is no setTag() method.
*/
public final byte getTag() {
@@ -351,6 +368,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Sets the constant pool to be used for this object.
+ *
* @param constantPool Constant pool to be used for this object.
* @see ConstantPool
*/
@@ -359,6 +378,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Sets the length in bytes.
+ *
* @param length length in bytes.
*/
public final void setLength(final int length) {
@@ -366,6 +387,8 @@ public abstract class Attribute implements Cloneable, Node {
}
/**
+ * Sets the name index of attribute.
+ *
* @param nameIndex of attribute.
*/
public final void setNameIndex(final int nameIndex) {
diff --git a/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
b/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
index 5f430016..91f85aff 100644
--- a/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
@@ -22,6 +22,8 @@ import java.io.DataOutputStream;
import java.io.IOException;
/**
+ * Represents a class element value in an annotation.
+ *
* @since 6.0
*/
public class ClassElementValue extends ElementValue {
diff --git a/src/main/java/org/apache/bcel/classfile/ElementValue.java
b/src/main/java/org/apache/bcel/classfile/ElementValue.java
index 5a6c6771..096c6fd3 100644
--- a/src/main/java/org/apache/bcel/classfile/ElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ElementValue.java
@@ -150,9 +150,20 @@ public abstract class ElementValue {
this.cpool = cpool;
}
+ /**
+ * Dumps this element value to a DataOutputStream.
+ *
+ * @param dos the output stream.
+ * @throws IOException if an I/O error occurs.
+ */
public abstract void dump(DataOutputStream dos) throws IOException;
- /** @since 6.0 */
+ /**
+ * Gets the constant pool.
+ *
+ * @return the constant pool.
+ * @since 6.0
+ */
final ConstantPool getConstantPool() {
return cpool;
}
@@ -161,7 +172,12 @@ public abstract class ElementValue {
return type;
}
- /** @since 6.0 */
+ /**
+ * Gets the type.
+ *
+ * @return the type.
+ * @since 6.0
+ */
final int getType() {
return type;
}
diff --git a/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
b/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
index ac0c6a95..0fafd791 100644
--- a/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
@@ -22,6 +22,8 @@ import java.io.DataOutputStream;
import java.io.IOException;
/**
+ * Represents an enum element value in an annotation.
+ *
* @since 6.0
*/
public class EnumElementValue extends ElementValue {
diff --git
a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
index a4b5e0ef..8ec2cf05 100644
--- a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
@@ -58,6 +58,8 @@ import org.apache.bcel.util.Args;
// J5TODO: Needs some testing !
/**
+ * Represents the LocalVariableTypeTable attribute.
+ *
* @since 6.0
*/
public class LocalVariableTypeTable extends Attribute implements
Iterable<LocalVariable> {
diff --git a/src/main/java/org/apache/bcel/classfile/Method.java
b/src/main/java/org/apache/bcel/classfile/Method.java
index 5dd62fff..b2cd38c7 100644
--- a/src/main/java/org/apache/bcel/classfile/Method.java
+++ b/src/main/java/org/apache/bcel/classfile/Method.java
@@ -168,7 +168,7 @@ public final class Method extends FieldOrMethod {
}
/**
- * @return LineNumberTable of code attribute if any, i.e. the call is
forwarded to the Code atribute.
+ * @return LineNumberTable of code attribute if any, for example the call
is forwarded to the Code atribute.
*/
public LineNumberTable getLineNumberTable() {
final Code code = getCode();
@@ -179,7 +179,7 @@ public final class Method extends FieldOrMethod {
}
/**
- * @return LocalVariableTable of code attribute if any, i.e. the call is
forwarded to the Code attribute.
+ * @return LocalVariableTable of code attribute if any, for example the
call is forwarded to the Code attribute.
*/
public LocalVariableTable getLocalVariableTable() {
final Code code = getCode();
@@ -192,7 +192,7 @@ public final class Method extends FieldOrMethod {
/**
* Gets the local variable type table attribute {@link
LocalVariableTypeTable}.
*
- * @return LocalVariableTypeTable of code attribute if any, i.e. the call
is forwarded to the Code attribute.
+ * @return LocalVariableTypeTable of code attribute if any, for example
the call is forwarded to the Code attribute.
* @since 6.10.0
*/
public LocalVariableTypeTable getLocalVariableTypeTable() {
diff --git a/src/main/java/org/apache/bcel/classfile/Node.java
b/src/main/java/org/apache/bcel/classfile/Node.java
index 062f6453..ba46fae3 100644
--- a/src/main/java/org/apache/bcel/classfile/Node.java
+++ b/src/main/java/org/apache/bcel/classfile/Node.java
@@ -23,5 +23,10 @@ package org.apache.bcel.classfile;
*/
public interface Node {
+ /**
+ * Accepts a visitor.
+ *
+ * @param visitor the visitor.
+ */
void accept(Visitor visitor);
}
diff --git a/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
b/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
index 56c96f11..975f8aa9 100644
--- a/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
@@ -24,6 +24,8 @@ import java.io.IOException;
import org.apache.bcel.Const;
/**
+ * Represents a simple element value in an annotation.
+ *
* @since 6.0
*/
public class SimpleElementValue extends ElementValue {
diff --git a/src/main/java/org/apache/bcel/generic/ANEWARRAY.java
b/src/main/java/org/apache/bcel/generic/ANEWARRAY.java
index 2fd1b0af..ae620b4d 100644
--- a/src/main/java/org/apache/bcel/generic/ANEWARRAY.java
+++ b/src/main/java/org/apache/bcel/generic/ANEWARRAY.java
@@ -35,6 +35,11 @@ public class ANEWARRAY extends CPInstruction implements
LoadClass, AllocationIns
ANEWARRAY() {
}
+ /**
+ * Constructs an ANEWARRAY instruction.
+ *
+ * @param index index into the constant pool.
+ */
public ANEWARRAY(final int index) {
super(org.apache.bcel.Const.ANEWARRAY, index);
}
diff --git
a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
index 5fe22319..2306e992 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
@@ -25,22 +25,44 @@ import org.apache.bcel.classfile.AnnotationElementValue;
import org.apache.bcel.classfile.ElementValue;
/**
+ * Generates annotation element values.
+ *
* @since 6.0
*/
public class AnnotationElementValueGen extends ElementValueGen {
// For annotation element values, this is the annotation
private final AnnotationEntryGen a;
+ /**
+ * Constructs an AnnotationElementValueGen.
+ *
+ * @param value the annotation element value.
+ * @param cpool the constant pool generator.
+ * @param copyPoolEntries whether to copy pool entries.
+ */
public AnnotationElementValueGen(final AnnotationElementValue value, final
ConstantPoolGen cpool, final boolean copyPoolEntries) {
super(ANNOTATION, cpool);
a = new AnnotationEntryGen(value.getAnnotationEntry(), cpool,
copyPoolEntries);
}
+ /**
+ * Constructs an AnnotationElementValueGen.
+ *
+ * @param a the annotation entry generator.
+ * @param cpool the constant pool generator.
+ */
public AnnotationElementValueGen(final AnnotationEntryGen a, final
ConstantPoolGen cpool) {
super(ANNOTATION, cpool);
this.a = a;
}
+ /**
+ * Constructs an AnnotationElementValueGen.
+ *
+ * @param type the type.
+ * @param annotation the annotation.
+ * @param cpool the constant pool generator.
+ */
public AnnotationElementValueGen(final int type, final AnnotationEntryGen
annotation, final ConstantPoolGen cpool) {
super(type, cpool);
if (type != ANNOTATION) {
@@ -55,12 +77,19 @@ public class AnnotationElementValueGen extends
ElementValueGen {
a.dump(dos);
}
+ /**
+ * Gets the annotation.
+ *
+ * @return the annotation.
+ */
public AnnotationEntryGen getAnnotation() {
return a;
}
/**
- * Return immutable variant of this AnnotationElementValueGen
+ * Returns an immutable variant of this AnnotationElementValueGen.
+ *
+ * @return an immutable variant of this AnnotationElementValueGen.
*/
@Override
public ElementValue getElementValue() {
diff --git a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
index 1efa556c..0e66dbe4 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
@@ -40,6 +40,8 @@ import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.stream.Streams;
/**
+ * Generates annotation entries.
+ *
* @since 6.0
*/
public class AnnotationEntryGen {
@@ -224,6 +226,10 @@ public class AnnotationEntryGen {
* passed in is for a different class file, then copyPoolEntries should
have been passed as true as that will force us
* to do a deep copy of the annotation and move the cpool entries across.
We need to copy the type and the element name
* value pairs and the visibility.
+ *
+ * @param a the annotation entry.
+ * @param cpool the constant pool generator.
+ * @param copyPoolEntries whether to copy pool entries.
*/
public AnnotationEntryGen(final AnnotationEntry a, final ConstantPoolGen
cpool, final boolean copyPoolEntries) {
this.cpool = cpool;
@@ -267,7 +273,9 @@ public class AnnotationEntryGen {
}
/**
- * Retrieve an immutable version of this AnnotationGen
+ * Retrieves an immutable version of this AnnotationGen.
+ *
+ * @return an immutable version of this AnnotationGen.
*/
public AnnotationEntry getAnnotation() {
final AnnotationEntry a = new AnnotationEntry(typeIndex,
cpool.getConstantPool(), isRuntimeVisible);
diff --git a/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
index 95ac04fe..ace560e1 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
@@ -29,6 +29,8 @@ import org.apache.bcel.classfile.ElementValue;
import org.apache.commons.lang3.stream.Streams;
/**
+ * Generates array element values in annotations.
+ *
* @since 6.0
*/
public class ArrayElementValueGen extends ElementValueGen {
diff --git a/src/main/java/org/apache/bcel/generic/ArrayInstruction.java
b/src/main/java/org/apache/bcel/generic/ArrayInstruction.java
index f0fac760..458fd6ee 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayInstruction.java
@@ -32,7 +32,9 @@ public abstract class ArrayInstruction extends Instruction
implements ExceptionT
}
/**
- * @param opcode of instruction
+ * Constructs an ArrayInstruction.
+ *
+ * @param opcode of instruction.
*/
protected ArrayInstruction(final short opcode) {
super(opcode, (short) 1);
diff --git a/src/main/java/org/apache/bcel/generic/CPInstruction.java
b/src/main/java/org/apache/bcel/generic/CPInstruction.java
index a732a5a8..321410e8 100644
--- a/src/main/java/org/apache/bcel/generic/CPInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/CPInstruction.java
@@ -49,7 +49,10 @@ public abstract class CPInstruction extends Instruction
implements TypedInstruct
}
/**
- * @param index to constant pool
+ * Constructs a CPInstruction.
+ *
+ * @param opcode the opcode.
+ * @param index to constant pool.
*/
protected CPInstruction(final short opcode, final int index) {
super(opcode, (short) 3);
diff --git a/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
index 4805668f..937bf3e4 100644
--- a/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
@@ -26,6 +26,8 @@ import org.apache.bcel.classfile.ConstantUtf8;
import org.apache.bcel.classfile.ElementValue;
/**
+ * Generates class element values in annotations.
+ *
* @since 6.0
*/
public class ClassElementValueGen extends ElementValueGen {
diff --git a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
index 84f752bb..af2b3e7a 100644
--- a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
+++ b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
@@ -23,7 +23,7 @@ import org.apache.bcel.classfile.CodeException;
/**
* This class represents an exception handler, i.e., specifies the region
where a handler is active and an instruction
* where the actual handling is done. pool as parameters. Opposed to the JVM
specification the end of the handled region
- * is set to be inclusive, i.e. all instructions between start and end are
protected including the start and end
+ * is set to be inclusive, for example all instructions between start and end
are protected including the start and end
* instructions (handles) themselves. The end of the region is automatically
mapped to be exclusive when calling
* getCodeException(), i.e., there is no difference semantically.
*
diff --git a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
index 3e22898c..b1dc9d47 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
@@ -31,6 +31,8 @@ import org.apache.bcel.classfile.EnumElementValue;
import org.apache.bcel.classfile.SimpleElementValue;
/**
+ * Generates element values in annotations.
+ *
* @since 6.0
*/
public abstract class ElementValueGen {
@@ -62,6 +64,11 @@ public abstract class ElementValueGen {
/**
* Creates an (modifiable) ElementValueGen copy of an (immutable)
ElementValue - constant pool is assumed correct.
+ *
+ * @param value the element value to copy.
+ * @param cpool the constant pool generator.
+ * @param copyPoolEntries whether to copy pool entries.
+ * @return a copy of the element value.
*/
public static ElementValueGen copy(final ElementValue value, final
ConstantPoolGen cpool, final boolean copyPoolEntries) {
switch (value.getElementValueType()) {
@@ -147,6 +154,12 @@ public abstract class ElementValueGen {
this.cpGen = cpGen;
}
+ /**
+ * Dumps this element value to a DataOutputStream.
+ *
+ * @param dos the output stream.
+ * @throws IOException if an I/O error occurs.
+ */
public abstract void dump(DataOutputStream dos) throws IOException;
protected ConstantPoolGen getConstantPool() {
@@ -154,7 +167,9 @@ public abstract class ElementValueGen {
}
/**
- * Subtypes return an immutable variant of the ElementValueGen
+ * Subtypes return an immutable variant of the ElementValueGen.
+ *
+ * @return an immutable variant of the ElementValueGen.
*/
public abstract ElementValue getElementValue();
diff --git a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
index 1928663b..ab01cb81 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
@@ -26,6 +26,8 @@ import org.apache.bcel.classfile.ElementValue;
import org.apache.bcel.classfile.ElementValuePair;
/**
+ * Generates element value pairs in annotations.
+ *
* @since 6.0
*/
public class ElementValuePairGen {
diff --git a/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
b/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
index 2213330e..2220a9d5 100644
--- a/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
@@ -26,6 +26,8 @@ import org.apache.bcel.classfile.ElementValue;
import org.apache.bcel.classfile.EnumElementValue;
/**
+ * Generates enum element values in annotations.
+ *
* @since 6.0
*/
public class EnumElementValueGen extends ElementValueGen {
diff --git a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
index c1156824..635fd066 100644
--- a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
+++ b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
@@ -31,5 +31,10 @@ package org.apache.bcel.generic;
*/
public interface ExceptionThrower {
+ /**
+ * Gets the exceptions that may be thrown by this instruction.
+ *
+ * @return the exceptions that may be thrown by this instruction.
+ */
Class<?>[] getExceptions();
}
diff --git a/src/main/java/org/apache/bcel/generic/Instruction.java
b/src/main/java/org/apache/bcel/generic/Instruction.java
index d3f47aa1..5978e9c5 100644
--- a/src/main/java/org/apache/bcel/generic/Instruction.java
+++ b/src/main/java/org/apache/bcel/generic/Instruction.java
@@ -400,6 +400,7 @@ public abstract class Instruction implements Cloneable {
/**
* Sets comparator to be used for equals().
*
+ * @param c the comparator.
* @deprecated (6.0) use the built in comparator, or wrap this class in
another object that implements these methods
*/
@Deprecated
@@ -442,6 +443,7 @@ public abstract class Instruction implements Cloneable {
* This method also gives right results for instructions whose effect on
the stack depends on the constant pool entry
* they reference.
*
+ * @param cpg the constant pool generator.
* @return Number of words consumed from stack by this instruction, or
Constants.UNPREDICTABLE, if this cannot be
* computed statically
*/
@@ -498,21 +500,27 @@ public abstract class Instruction implements Cloneable {
}
/**
- * @return length (in bytes) of instruction
+ * Gets the length (in bytes) of instruction.
+ *
+ * @return length (in bytes) of instruction.
*/
public int getLength() {
return length;
}
/**
- * @return name of instruction, i.e., opcode name
+ * Gets the name of instruction, i.e., opcode name.
+ *
+ * @return name of instruction, i.e., opcode name.
*/
public String getName() {
return Const.getOpcodeName(opcode);
}
/**
- * @return this instructions opcode
+ * Gets this instruction's opcode.
+ *
+ * @return this instruction's opcode.
*/
public short getOpcode() {
return opcode;
@@ -544,6 +552,7 @@ public abstract class Instruction implements Cloneable {
* This method also gives right results for instructions whose effect on
the stack depends on the constant pool entry
* they reference.
*
+ * @param cpg the constant pool generator.
* @return Number of words produced onto stack by this instruction, or
Constants.UNPREDICTABLE, if this cannot be
* computed statically
*/
@@ -591,7 +600,10 @@ public abstract class Instruction implements Cloneable {
}
/**
- * @return mnemonic for instruction with sumbolic references resolved
+ * Gets the mnemonic for instruction with symbolic references resolved.
+ *
+ * @param cp the constant pool.
+ * @return mnemonic for instruction with symbolic references resolved.
*/
public String toString(final ConstantPool cp) {
return toString(false);
diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
index ff61bcca..4dc2f9f1 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
@@ -679,7 +679,7 @@ public class InstructionFactory implements
InstructionConstants {
/**
* Create new array of given size and type.
*
- * @return an instruction that creates the corresponding array at runtime,
i.e. is an AllocationInstruction
+ * @return an instruction that creates the corresponding array at runtime,
for example is an AllocationInstruction
*/
public Instruction createNewArray(final Type t, final short dim) {
if (dim == 1) {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 8bd7cd2d..9dfe3f31 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -52,8 +52,8 @@ public class InstructionList implements
Iterable<InstructionHandle> {
/**
* Find the target instruction (handle) that corresponds to the given
target position (byte code offset).
*
- * @param ihs array of instruction handles, i.e. il.getInstructionHandles()
- * @param pos array of positions corresponding to ihs, i.e.
il.getInstructionPositions()
+ * @param ihs array of instruction handles, for example
il.getInstructionHandles()
+ * @param pos array of positions corresponding to ihs, for example
il.getInstructionPositions()
* @param count length of arrays
* @param target target position to search for
* @return target position's instruction handle if available
diff --git a/src/main/java/org/apache/bcel/generic/LoadInstruction.java
b/src/main/java/org/apache/bcel/generic/LoadInstruction.java
index 6a2c3b21..9751af93 100644
--- a/src/main/java/org/apache/bcel/generic/LoadInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LoadInstruction.java
@@ -32,9 +32,11 @@ public abstract class LoadInstruction extends
LocalVariableInstruction implement
}
/**
- * @param opcode Instruction opcode
- * @param cTag Instruction number for compact version, ALOAD_0, for example
- * @param n local variable index (unsigned short)
+ * Constructs a LoadInstruction.
+ *
+ * @param opcode Instruction opcode.
+ * @param cTag Instruction number for compact version, ALOAD_0, for
example.
+ * @param n local variable index (unsigned short).
*/
protected LoadInstruction(final short opcode, final short cTag, final int
n) {
super(opcode, cTag, n);
diff --git
a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
index 404cff1c..28cb6951 100644
--- a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
@@ -54,9 +54,11 @@ public abstract class LocalVariableInstruction extends
Instruction implements Ty
}
/**
- * @param opcode Instruction opcode
+ * Constructs a LocalVariableInstruction.
+ *
+ * @param opcode Instruction opcode.
* @param cTag Instruction number for compact version, ALOAD_0, for
example.
- * @param n local variable index (unsigned short)
+ * @param n local variable index (unsigned short).
*/
protected LocalVariableInstruction(final short opcode, final short cTag,
final int n) {
super(opcode, (short) 2);
@@ -86,7 +88,9 @@ public abstract class LocalVariableInstruction extends
Instruction implements Ty
}
/**
- * @return canonical tag for instruction, for example, ALOAD for ALOAD_0
+ * Gets the canonical tag for instruction, for example, ALOAD for ALOAD_0.
+ *
+ * @return canonical tag for instruction, for example, ALOAD for ALOAD_0.
*/
public short getCanonicalTag() {
return canonTag;
diff --git a/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
b/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
index a9cc0af4..de108024 100644
--- a/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
@@ -30,6 +30,8 @@ import org.apache.bcel.classfile.ElementValue;
import org.apache.bcel.classfile.SimpleElementValue;
/**
+ * Generates simple element values in annotations.
+ *
* @since 6.0
*/
public class SimpleElementValueGen extends ElementValueGen {
diff --git a/src/main/java/org/apache/bcel/generic/StackConsumer.java
b/src/main/java/org/apache/bcel/generic/StackConsumer.java
index d31da8e2..04576827 100644
--- a/src/main/java/org/apache/bcel/generic/StackConsumer.java
+++ b/src/main/java/org/apache/bcel/generic/StackConsumer.java
@@ -24,7 +24,10 @@ package org.apache.bcel.generic;
public interface StackConsumer {
/**
- * @return how many words are consumed from stack
+ * Gets how many words are consumed from stack.
+ *
+ * @param cpg the constant pool generator.
+ * @return how many words are consumed from stack.
*/
int consumeStack(ConstantPoolGen cpg);
}
diff --git a/src/main/java/org/apache/bcel/generic/StackProducer.java
b/src/main/java/org/apache/bcel/generic/StackProducer.java
index 6c118412..9e4edf4a 100644
--- a/src/main/java/org/apache/bcel/generic/StackProducer.java
+++ b/src/main/java/org/apache/bcel/generic/StackProducer.java
@@ -24,7 +24,10 @@ package org.apache.bcel.generic;
public interface StackProducer {
/**
- * @return how many words are produced on stack
+ * Gets how many words are produced on stack.
+ *
+ * @param cpg the constant pool generator.
+ * @return how many words are produced on stack.
*/
int produceStack(ConstantPoolGen cpg);
}
diff --git a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
index 9f46e0fc..7a45e7f0 100644
--- a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
@@ -23,5 +23,11 @@ package org.apache.bcel.generic;
*/
public interface TypedInstruction {
+ /**
+ * Gets the type associated with this instruction.
+ *
+ * @param cpg the constant pool generator.
+ * @return the type associated with this instruction.
+ */
Type getType(ConstantPoolGen cpg);
}
diff --git a/src/main/java/org/apache/bcel/util/ClassLoader.java
b/src/main/java/org/apache/bcel/util/ClassLoader.java
index 1368038d..316e3f00 100644
--- a/src/main/java/org/apache/bcel/util/ClassLoader.java
+++ b/src/main/java/org/apache/bcel/util/ClassLoader.java
@@ -66,7 +66,7 @@ public class ClassLoader extends java.lang.ClassLoader {
private Repository repository = SyntheticRepository.getInstance();
/**
- * Ignored packages are by default ( "java.", "sun.", "javax."), i.e.
loaded by system class loader
+ * Ignored packages are by default ( "java.", "sun.", "javax."), for
example loaded by system class loader
*/
public ClassLoader() {
this(DEFAULT_IGNORED_PACKAGES);
diff --git a/src/main/java/org/apache/bcel/util/ClassPath.java
b/src/main/java/org/apache/bcel/util/ClassPath.java
index 64100877..a2af629c 100644
--- a/src/main/java/org/apache/bcel/util/ClassPath.java
+++ b/src/main/java/org/apache/bcel/util/ClassPath.java
@@ -146,7 +146,7 @@ public class ClassPath implements Closeable {
public interface ClassFile {
/**
- * @return base path of found class, i.e. class is contained relative
to that path, which may either denote a directory,
+ * @return base path of found class, for example class is contained
relative to that path, which may either denote a directory,
* or ZIP file
*/
String getBase();
diff --git a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
index bf48ad00..d0a17d0d 100644
--- a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
@@ -88,7 +88,7 @@ public abstract class PassVerifier {
/**
* This method runs a verification pass conforming to the Java Virtual
Machine Specification, 2nd edition, on a class
- * file. PassVerifier instances perform caching; i.e. if the verify()
method once determined a VerificationResult, then
+ * file. PassVerifier instances perform caching; for example if the
verify() method once determined a VerificationResult, then
* this result may be returned after every invocation of this method
instead of running the verification pass anew;
* likewise with the result of getMessages().
*
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 caa64c29..7588cbd5 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
@@ -170,7 +170,7 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
return;
}
final Method m = (Method) carrier.predecessor(); // we can
assume this method was visited before;
- // i.e. the
data consistency was verified.
+ // for
example the data consistency was verified.
if (obj.getCode().length == 0) {
throw new ClassConstraintException("Code array of Code
attribute '" + tostring(obj) + "' (method '" + m + "') must not be empty.");
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 0f903d84..d58eaa13 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
@@ -1032,7 +1032,7 @@ public final class Pass3aVerifier extends PassVerifier {
// Only after that we should try to build an InstructionList
and throw an
// AssertionViolatedException if after our examination
InstructionList building
// still fails.
- // That examination should be implemented in a byte-oriented
way, i.e. look for
+ // That examination should be implemented in a byte-oriented
way, for example look for
// an instruction, make sure its validity, count its length,
find the next
// instruction and so on.
try {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
b/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
index 150850f1..ba433f13 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
@@ -288,7 +288,7 @@ public class ControlFlowGraph {
/**
* Returns the InstructionContextImpl with an JSR/JSR_W that was last
in the ExecutionChain, without a corresponding
- * RET, i.e. we were called by this one. Returns null if we were
called from the top level.
+ * RET, for example we were called by this one. Returns null if we
were called from the top level.
*/
private InstructionContextImpl lastExecutionJSR() {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
index b9ec029f..032a2fd0 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
@@ -42,7 +42,7 @@ public class LocalVariables implements Cloneable {
}
/**
- * Returns a deep copy of this object; i.e. the clone operates on a new
local variable array. However, the Type objects
+ * Returns a deep copy of this object; for example the clone operates on a
new local variable array. However, the Type objects
* in the array are shared.
*/
@Override
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 0652b096..1ec839d9 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
@@ -62,7 +62,7 @@ public final class Pass3bVerifier extends PassVerifier {
/**
* An InstructionContextQueue is a utility class that holds
(InstructionContext, ArrayList) pairs in a Queue data
- * structure. This is used to hold information about InstructionContext
objects externally --- i.e. that information is
+ * structure. This is used to hold information about InstructionContext
objects externally --- for example that information is
* not saved inside the InstructionContext object itself. This is useful
to save the execution path of the symbolic
* execution of the Pass3bVerifier - this is not information that belongs
into the InstructionContext object itself.
* Only at "execute()"ing time, an InstructionContext object will get the
current information we have about its symbolic
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 20948f1a..c8a42747 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
@@ -69,7 +69,7 @@ public class Subroutines {
private final class SubroutineImpl implements Subroutine {
/**
- * UNSET, a symbol for an uninitialized localVariable field. This is
used for the "top-level" Subroutine; i.e. no
+ * UNSET, a symbol for an uninitialized localVariable field. This is
used for the "top-level" Subroutine; for example no
* subroutine.
*/
private static final int UNSET = -1;
@@ -609,7 +609,7 @@ public class Subroutines {
/**
* Returns the subroutine object associated with the given instruction.
This is a costly operation, you should consider
* using getSubroutine(InstructionHandle). Returns 'null' if the given
InstructionHandle lies in so-called 'dead code',
- * i.e. code that can never be executed.
+ * for example code that can never be executed.
*
* @see #getSubroutine(InstructionHandle)
* @see #getTopLevel()
diff --git a/src/test/java/org/apache/bcel/AbstractTest.java
b/src/test/java/org/apache/bcel/AbstractTest.java
index e41f69ed..479a668b 100644
--- a/src/test/java/org/apache/bcel/AbstractTest.java
+++ b/src/test/java/org/apache/bcel/AbstractTest.java
@@ -52,7 +52,7 @@ public abstract class AbstractTest {
// Location of test data
protected static final File TESTDATA = new File("target", "testdata");
- // package base name in signature format, i.e. with '/' separators instead
of '.'
+ // package base name in signature format, for example with '/' separators
instead of '.'
protected static final String PACKAGE_BASE_SIG =
Utility.packageToPath(PACKAGE_BASE_NAME);
public static void clear() {
diff --git a/src/test/java/org/apache/bcel/EnclosingMethodAttributeTest.java
b/src/test/java/org/apache/bcel/EnclosingMethodAttributeTest.java
index aee9c20a..9fdfdf87 100644
--- a/src/test/java/org/apache/bcel/EnclosingMethodAttributeTest.java
+++ b/src/test/java/org/apache/bcel/EnclosingMethodAttributeTest.java
@@ -58,7 +58,7 @@ class EnclosingMethodAttributeTest extends AbstractTest {
}
/**
- * Verify for an inner class declared at the type level that the
EnclosingMethod attribute is set correctly (i.e. to a
+ * Verify for an inner class declared at the type level that the
EnclosingMethod attribute is set correctly (for example to a
* null value)
*/
@Test
