You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/12/31 13:31:37 UTC
(commons-bcel) 02/02: Javadoc: English, not Latin
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git
commit 4580fc6a35f22fa4a0d9592c1286d4f9016893df
Author: Gary D. Gregory <ga...@gmail.com>
AuthorDate: Tue Dec 31 08:31:24 2024 -0500
Javadoc: English, not Latin
---
src/examples/Id.java | 2 +-
src/main/java/org/apache/bcel/Const.java | 10 ++++----
src/main/java/org/apache/bcel/Constants.java | 6 ++---
src/main/java/org/apache/bcel/Repository.java | 2 +-
.../org/apache/bcel/classfile/ConstantObject.java | 4 +--
.../org/apache/bcel/classfile/EmptyVisitor.java | 2 +-
.../java/org/apache/bcel/classfile/Method.java | 2 +-
.../java/org/apache/bcel/classfile/Utility.java | 8 +++---
.../java/org/apache/bcel/generic/ArrayType.java | 6 ++---
src/main/java/org/apache/bcel/generic/BIPUSH.java | 2 +-
.../org/apache/bcel/generic/BranchInstruction.java | 2 +-
.../java/org/apache/bcel/generic/ClassGen.java | 2 +-
.../org/apache/bcel/generic/ConstantPoolGen.java | 3 +--
.../org/apache/bcel/generic/FieldOrMethod.java | 2 +-
src/main/java/org/apache/bcel/generic/GOTO_W.java | 2 +-
src/main/java/org/apache/bcel/generic/IFEQ.java | 2 +-
src/main/java/org/apache/bcel/generic/IINC.java | 2 +-
.../org/apache/bcel/generic/IfInstruction.java | 2 +-
.../apache/bcel/generic/IndexedInstruction.java | 2 +-
.../java/org/apache/bcel/generic/Instruction.java | 2 +-
.../org/apache/bcel/generic/InstructionConst.java | 4 +--
.../apache/bcel/generic/InstructionConstants.java | 2 +-
.../apache/bcel/generic/InstructionFactory.java | 12 ++++-----
.../org/apache/bcel/generic/InstructionList.java | 4 +--
src/main/java/org/apache/bcel/generic/JSR_W.java | 2 +-
src/main/java/org/apache/bcel/generic/LDC.java | 2 +-
.../java/org/apache/bcel/generic/LOOKUPSWITCH.java | 2 +-
.../org/apache/bcel/generic/LoadInstruction.java | 4 +--
.../bcel/generic/LocalVariableInstruction.java | 8 +++---
.../java/org/apache/bcel/generic/MethodGen.java | 4 +--
.../java/org/apache/bcel/generic/NEWARRAY.java | 2 +-
.../java/org/apache/bcel/generic/ObjectType.java | 4 +--
src/main/java/org/apache/bcel/generic/RET.java | 2 +-
.../org/apache/bcel/generic/ReferenceType.java | 2 +-
src/main/java/org/apache/bcel/generic/SIPUSH.java | 2 +-
src/main/java/org/apache/bcel/generic/Select.java | 2 +-
.../org/apache/bcel/generic/StackProducer.java | 2 +-
.../org/apache/bcel/generic/StoreInstruction.java | 4 +--
.../java/org/apache/bcel/generic/TABLESWITCH.java | 2 +-
src/main/java/org/apache/bcel/generic/Type.java | 6 ++---
.../bcel/util/AbstractClassPathRepository.java | 2 +-
src/main/java/org/apache/bcel/util/Class2HTML.java | 2 +-
src/main/java/org/apache/bcel/util/ClassPath.java | 30 +++++++++++-----------
src/main/java/org/apache/bcel/util/CodeHTML.java | 2 +-
.../org/apache/bcel/util/InstructionFinder.java | 8 +++---
.../bcel/verifier/statics/Pass1Verifier.java | 6 ++---
.../bcel/verifier/statics/Pass3aVerifier.java | 2 +-
.../verifier/statics/StringRepresentation.java | 4 +--
.../verifier/structurals/ControlFlowGraph.java | 2 +-
.../structurals/InstConstraintVisitor.java | 2 +-
.../bcel/generic/JdkGenericDumpTestCase.java | 2 +-
51 files changed, 99 insertions(+), 100 deletions(-)
diff --git a/src/examples/Id.java b/src/examples/Id.java
index b86bcdf4..82b184f6 100644
--- a/src/examples/Id.java
+++ b/src/examples/Id.java
@@ -28,7 +28,7 @@ import org.apache.bcel.generic.MethodGen;
/**
* Test BCEL if an input file is identical to the outfile generated with BCEL. Of course there may some small
- * differences, e.g., because BCEL generates local variable tables by default.
+ * differences, for example, because BCEL generates local variable tables by default.
*
* Try to:
*
diff --git a/src/main/java/org/apache/bcel/Const.java b/src/main/java/org/apache/bcel/Const.java
index a72e6949..23c5f938 100644
--- a/src/main/java/org/apache/bcel/Const.java
+++ b/src/main/java/org/apache/bcel/Const.java
@@ -2899,20 +2899,20 @@ public final class Const {
public static final byte T_ADDRESS = 16;
/**
- * The primitive type names corresponding to the T_XX constants, e.g., TYPE_NAMES[T_INT] = "int"
+ * The primitive type names corresponding to the T_XX constants, for example, TYPE_NAMES[T_INT] = "int"
*/
private static final String[] TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "boolean", "char", "float", "double", "byte", "short",
"int", "long", "void", "array", "object", "unknown", "address"};
/**
- * The primitive class names corresponding to the T_XX constants, e.g., CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
+ * The primitive class names corresponding to the T_XX constants, for example, CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
*/
private static final String[] CLASS_TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "java.lang.Boolean", "java.lang.Character",
"java.lang.Float", "java.lang.Double", "java.lang.Byte", "java.lang.Short", "java.lang.Integer", "java.lang.Long", "java.lang.Void", ILLEGAL_TYPE,
ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE};
/**
- * The signature characters corresponding to primitive types, e.g., SHORT_TYPE_NAMES[T_INT] = "I"
+ * The signature characters corresponding to primitive types, for example, SHORT_TYPE_NAMES[T_INT] = "I"
*/
public static final String[] SHORT_TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "Z", "C", "F", "D", "B", "S", "I", "J", "V",
ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE};
@@ -3207,7 +3207,7 @@ public final class Const {
}
/**
- * The primitive class names corresponding to the T_XX constants, e.g., CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
+ * The primitive class names corresponding to the T_XX constants, for example, CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
*
* @param index index into {@code CLASS_TYPE_NAMES}.
* @return the class name
@@ -3318,7 +3318,7 @@ public final class Const {
}
/**
- * The primitive type names corresponding to the T_XX constants, e.g., TYPE_NAMES[T_INT] = "int"
+ * The primitive type names corresponding to the T_XX constants, for example, TYPE_NAMES[T_INT] = "int"
*
* @param index
* @return the type name
diff --git a/src/main/java/org/apache/bcel/Constants.java b/src/main/java/org/apache/bcel/Constants.java
index 0632acfb..9a963110 100644
--- a/src/main/java/org/apache/bcel/Constants.java
+++ b/src/main/java/org/apache/bcel/Constants.java
@@ -2348,20 +2348,20 @@ public interface Constants {
byte T_ADDRESS = Const.T_ADDRESS;
/**
- * The primitive type names corresponding to the T_XX constants, e.g., TYPE_NAMES[T_INT] = "int"
+ * The primitive type names corresponding to the T_XX constants, for example, TYPE_NAMES[T_INT] = "int"
*/
String[] TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "boolean", "char", "float", "double", "byte", "short", "int", "long", "void",
"array", "object", "unknown", "address"};
/**
- * The primitive class names corresponding to the T_XX constants, e.g., CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
+ * The primitive class names corresponding to the T_XX constants, for example, CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer"
*/
String[] CLASS_TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "java.lang.Boolean", "java.lang.Character", "java.lang.Float",
"java.lang.Double", "java.lang.Byte", "java.lang.Short", "java.lang.Integer", "java.lang.Long", "java.lang.Void", ILLEGAL_TYPE, ILLEGAL_TYPE,
ILLEGAL_TYPE, ILLEGAL_TYPE};
/**
- * The signature characters corresponding to primitive types, e.g., SHORT_TYPE_NAMES[T_INT] = "I"
+ * The signature characters corresponding to primitive types, for example, SHORT_TYPE_NAMES[T_INT] = "I"
*/
String[] SHORT_TYPE_NAMES = {ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE, "Z", "C", "F", "D", "B", "S", "I", "J", "V", ILLEGAL_TYPE,
ILLEGAL_TYPE, ILLEGAL_TYPE};
diff --git a/src/main/java/org/apache/bcel/Repository.java b/src/main/java/org/apache/bcel/Repository.java
index b04d8496..30062652 100644
--- a/src/main/java/org/apache/bcel/Repository.java
+++ b/src/main/java/org/apache/bcel/Repository.java
@@ -25,7 +25,7 @@ import org.apache.bcel.util.ClassPath;
import org.apache.bcel.util.SyntheticRepository;
/**
- * The repository maintains informations about class interdependencies, e.g., whether a class is a sub-class of another.
+ * The repository maintains informations about class interdependencies, for example, whether a class is a sub-class of another.
* Delegates actual class loading to SyntheticRepository with current class path by default.
*
* @see org.apache.bcel.util.Repository
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantObject.java b/src/main/java/org/apache/bcel/classfile/ConstantObject.java
index 5acc5653..5ea1e5a0 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantObject.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantObject.java
@@ -26,10 +26,10 @@ package org.apache.bcel.classfile;
public interface ConstantObject {
/**
- * Gets the object representing the constant, e.g., Long for ConstantLong.
+ * Gets the object representing the constant, for example, Long for ConstantLong.
*
* @param constantPool the constant.
- * @return object representing the constant, e.g., Long for ConstantLong.
+ * @return object representing the constant, for example, Long for ConstantLong.
*/
Object getConstantValue(ConstantPool constantPool);
}
diff --git a/src/main/java/org/apache/bcel/classfile/EmptyVisitor.java b/src/main/java/org/apache/bcel/classfile/EmptyVisitor.java
index 4489ab68..4e6b98af 100644
--- a/src/main/java/org/apache/bcel/classfile/EmptyVisitor.java
+++ b/src/main/java/org/apache/bcel/classfile/EmptyVisitor.java
@@ -19,7 +19,7 @@
package org.apache.bcel.classfile;
/**
- * Visitor with empty method bodies, can be extended and used in conjunction with the DescendingVisitor class, e.g. By
+ * Visitor with empty method bodies, can be extended and used in conjunction with the DescendingVisitor class, for example. By
* courtesy of David Spencer.
*
* @see DescendingVisitor
diff --git a/src/main/java/org/apache/bcel/classfile/Method.java b/src/main/java/org/apache/bcel/classfile/Method.java
index f8c9d28b..a01b0677 100644
--- a/src/main/java/org/apache/bcel/classfile/Method.java
+++ b/src/main/java/org/apache/bcel/classfile/Method.java
@@ -233,7 +233,7 @@ public final class Method extends FieldOrMethod {
/**
* Return string representation close to declaration format, 'public static void main(String[] args) throws
- * IOException', e.g.
+ * IOException', for example.
*
* @return String representation of the method.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java b/src/main/java/org/apache/bcel/classfile/Utility.java
index f4ba8e85..2438310e 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -247,7 +247,7 @@ public abstract class Utility {
* @param constantPool Array of constants
* @param index offset in 'code' array <EM>(number of opcodes, not bytes!)</EM>
* @param length number of opcodes to decompile, -1 for all
- * @param verbose be verbose, e.g. print constant pool index
+ * @param verbose be verbose, for example print constant pool index
* @return String representation of byte codes
*/
public static String codeToString(final byte[] code, final ConstantPool constantPool, final int index, final int length, final boolean verbose) {
@@ -277,7 +277,7 @@ public abstract class Utility {
*
* @param bytes stream of bytes
* @param constantPool Array of constants
- * @param verbose be verbose, e.g. print constant pool index
+ * @param verbose be verbose, for example print constant pool index
* @return String representation of byte code
* @throws IOException if a failure from reading from the bytes argument occurs
*/
@@ -759,7 +759,7 @@ public abstract class Utility {
*/
/**
- * Parse Java type such as "char", or "java.lang.String[]" and return the signature in byte code format, e.g. "C" or
+ * Parse Java type such as "char", or "java.lang.String[]" and return the signature in byte code format, for example "C" or
* "[Ljava/lang/String;" respectively.
*
* @param type Java type
@@ -1195,7 +1195,7 @@ public abstract class Utility {
* Convert bytes into hexadecimal string
*
* @param bytes an array of bytes to convert to hexadecimal
- * @return bytes as hexadecimal string, e.g. 00 fa 12 ...
+ * @return bytes as hexadecimal string, for example 00 fa 12 ...
*/
public static String toHexString(final byte[] bytes) {
final StringBuilder buf = new StringBuilder();
diff --git a/src/main/java/org/apache/bcel/generic/ArrayType.java b/src/main/java/org/apache/bcel/generic/ArrayType.java
index e7b1494f..f76e9a64 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayType.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayType.java
@@ -29,9 +29,9 @@ public final class ArrayType extends ReferenceType {
private final Type basicType;
/**
- * Convenience constructor for array type, e.g. int[]
+ * Convenience constructor for array type, for example int[]
*
- * @param type array type, e.g. T_INT
+ * @param type array type, for example T_INT
* @param dimensions array dimensions
*/
public ArrayType(final byte type, final int dimensions) {
@@ -39,7 +39,7 @@ public final class ArrayType extends ReferenceType {
}
/**
- * Convenience constructor for reference array type, e.g. Object[]
+ * Convenience constructor for reference array type, for example Object[]
*
* @param className complete name of class ({@link String}, for example)
* @param dimensions array dimensions
diff --git a/src/main/java/org/apache/bcel/generic/BIPUSH.java b/src/main/java/org/apache/bcel/generic/BIPUSH.java
index e2c6752e..e521b5be 100644
--- a/src/main/java/org/apache/bcel/generic/BIPUSH.java
+++ b/src/main/java/org/apache/bcel/generic/BIPUSH.java
@@ -86,7 +86,7 @@ public class BIPUSH extends Instruction implements ConstantPushInstruction {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/BranchInstruction.java b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
index dace9513..f32764b8 100644
--- a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
@@ -156,7 +156,7 @@ public abstract class BranchInstruction extends Instruction implements Instructi
}
/**
- * Read needed data (e.g. index) from file. Conversion to a InstructionHandle is done in InstructionList(byte[]).
+ * Read needed data (for example index) from file. Conversion to a InstructionHandle is done in InstructionList(byte[]).
*
* @param bytes input stream
* @param wide wide prefix?
diff --git a/src/main/java/org/apache/bcel/generic/ClassGen.java b/src/main/java/org/apache/bcel/generic/ClassGen.java
index 4558f7fc..bebaaacd 100644
--- a/src/main/java/org/apache/bcel/generic/ClassGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassGen.java
@@ -99,7 +99,7 @@ public class ClassGen extends AccessFlags implements Cloneable {
/**
* Constructs a new instance from an existing class.
*
- * @param clazz JavaClass object (e.g. read from file)
+ * @param clazz JavaClass object (for example read from file)
*/
public ClassGen(final JavaClass clazz) {
super(clazz.getAccessFlags());
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
index 0da0a3f6..daf406c4 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
@@ -224,8 +224,7 @@ public class ConstantPoolGen {
}
/**
- * Add a reference to an array class (e.g. String[][]) as needed by MULTIANEWARRAY instruction, e.g. to the
- * ConstantPool.
+ * Add a reference to an array class (for example, String[][]) as needed by MULTIANEWARRAY instruction, for example, to the ConstantPool.
*
* @param type type of array class
* @return index of entry
diff --git a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
index 4590f53b..1cbbc499 100644
--- a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
+++ b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
@@ -47,7 +47,7 @@ public abstract class FieldOrMethod extends CPInstruction implements LoadClass {
/**
* @return name of the referenced class/interface
* @deprecated If the instruction references an array class, this method will return "java.lang.Object". For code
- * generated by Java 1.5, this answer is sometimes wrong (e.g., if the "clone()" method is called on an
+ * generated by Java 1.5, this answer is sometimes wrong (for example, if the "clone()" method is called on an
* array). A better idea is to use the {@link #getReferenceType(ConstantPoolGen)} method, which correctly
* distinguishes between class types and array types.
*/
diff --git a/src/main/java/org/apache/bcel/generic/GOTO_W.java b/src/main/java/org/apache/bcel/generic/GOTO_W.java
index d20ad7f9..184c51e7 100644
--- a/src/main/java/org/apache/bcel/generic/GOTO_W.java
+++ b/src/main/java/org/apache/bcel/generic/GOTO_W.java
@@ -66,7 +66,7 @@ public class GOTO_W extends GotoInstruction {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/IFEQ.java b/src/main/java/org/apache/bcel/generic/IFEQ.java
index 6105ac68..379bebd1 100644
--- a/src/main/java/org/apache/bcel/generic/IFEQ.java
+++ b/src/main/java/org/apache/bcel/generic/IFEQ.java
@@ -52,7 +52,7 @@ public class IFEQ extends IfInstruction {
}
/**
- * @return negation of instruction, e.g. IFEQ.negate() == IFNE
+ * @return negation of instruction, for example IFEQ.negate() == IFNE
*/
@Override
public IfInstruction negate() {
diff --git a/src/main/java/org/apache/bcel/generic/IINC.java b/src/main/java/org/apache/bcel/generic/IINC.java
index 11d3dd75..14c06a59 100644
--- a/src/main/java/org/apache/bcel/generic/IINC.java
+++ b/src/main/java/org/apache/bcel/generic/IINC.java
@@ -98,7 +98,7 @@ public class IINC extends LocalVariableInstruction {
}
/**
- * Reads needed data (e.g. index) from file.
+ * Reads needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/IfInstruction.java b/src/main/java/org/apache/bcel/generic/IfInstruction.java
index c35de0ee..165c37d2 100644
--- a/src/main/java/org/apache/bcel/generic/IfInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/IfInstruction.java
@@ -38,7 +38,7 @@ public abstract class IfInstruction extends BranchInstruction implements StackCo
}
/**
- * @return negation of instruction, e.g. IFEQ.negate() == IFNE
+ * @return negation of instruction, for example IFEQ.negate() == IFNE
*/
public abstract IfInstruction negate();
}
diff --git a/src/main/java/org/apache/bcel/generic/IndexedInstruction.java b/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
index da773588..df43dea3 100644
--- a/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Denote entity that refers to an index, e.g. local variable instructions, RET, CPInstruction, etc.
+ * Denote entity that refers to an index, for example local variable instructions, RET, CPInstruction, etc.
*/
public interface IndexedInstruction {
diff --git a/src/main/java/org/apache/bcel/generic/Instruction.java b/src/main/java/org/apache/bcel/generic/Instruction.java
index 3e72370c..ca989787 100644
--- a/src/main/java/org/apache/bcel/generic/Instruction.java
+++ b/src/main/java/org/apache/bcel/generic/Instruction.java
@@ -529,7 +529,7 @@ public abstract class Instruction implements Cloneable {
}
/**
- * Reads needed data (e.g. index) from file.
+ * Reads needed data (for example index) from file.
*
* @param bytes byte sequence to read from
* @param wide "wide" instruction flag
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConst.java b/src/main/java/org/apache/bcel/generic/InstructionConst.java
index 99a92e23..7ee68d89 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConst.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConst.java
@@ -150,7 +150,7 @@ public final class InstructionConst {
/**
* You can use these constants in multiple places safely, if you can guarantee that you will never alter their internal
- * values, e.g. call setIndex().
+ * values, for example call setIndex().
*/
public static final LocalVariableInstruction THIS = new ALOAD(0);
public static final LocalVariableInstruction ALOAD_0 = THIS;
@@ -284,7 +284,7 @@ public final class InstructionConst {
/**
* Gets the Instruction.
*
- * @param index the index, e.g. {@link Const#RETURN}
+ * @param index the index, for example {@link Const#RETURN}
* @return the entry from the private INSTRUCTIONS table
*/
public static Instruction getInstruction(final int index) {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConstants.java b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
index ae678cba..05abc683 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConstants.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
@@ -156,7 +156,7 @@ public interface InstructionConstants {
/**
* You can use these constants in multiple places safely, if you can guarantee that you will never alter their internal
- * values, e.g. call setIndex().
+ * values, for example call setIndex().
*/
LocalVariableInstruction THIS = InstructionConst.THIS;
LocalVariableInstruction ALOAD_0 = InstructionConst.ALOAD_0;
diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
index 2c9dcea5..ff61bcca 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
@@ -21,7 +21,7 @@ package org.apache.bcel.generic;
import org.apache.bcel.Const;
/**
- * Instances of this class may be used, e.g., to generate typed versions of instructions. Its main purpose is to be used
+ * Instances of this class may be used, for example, to generate typed versions of instructions. Its main purpose is to be used
* as the byte code generating backend of a compiler. You can subclass it to add your own create methods.
* <p>
* Note: The static createXXX methods return singleton instances from the {@link InstructionConst} class.
@@ -308,21 +308,21 @@ public class InstructionFactory implements InstructionConstants {
}
/**
- * @param size size of operand, either 1 (int, e.g.) or 2 (double)
+ * @param size size of operand, either 1 (int, for example) or 2 (double)
*/
public static StackInstruction createDup(final int size) {
return size == 2 ? InstructionConst.DUP2 : InstructionConst.DUP;
}
/**
- * @param size size of operand, either 1 (int, e.g.) or 2 (double)
+ * @param size size of operand, either 1 (int, for example) or 2 (double)
*/
public static StackInstruction createDup_1(final int size) {
return size == 2 ? InstructionConst.DUP2_X1 : InstructionConst.DUP_X1;
}
/**
- * @param size size of operand, either 1 (int, e.g.) or 2 (double)
+ * @param size size of operand, either 1 (int, for example) or 2 (double)
*/
public static StackInstruction createDup_2(final int size) {
return size == 2 ? InstructionConst.DUP2_X2 : InstructionConst.DUP_X2;
@@ -381,7 +381,7 @@ public class InstructionFactory implements InstructionConstants {
}
/**
- * @param size size of operand, either 1 (int, e.g.) or 2 (double)
+ * @param size size of operand, either 1 (int, for example) or 2 (double)
*/
public static StackInstruction createPop(final int size) {
return size == 2 ? InstructionConst.POP2 : InstructionConst.POP;
@@ -505,7 +505,7 @@ public class InstructionFactory implements InstructionConstants {
}
/**
- * Create conversion operation for two stack operands, this may be an I2C, instruction, e.g., if the operands are basic
+ * Create conversion operation for two stack operands, this may be an I2C, instruction, for example, if the operands are basic
* types and CHECKCAST if they are reference types.
*/
public Instruction createCast(final Type srcType, final Type destType) {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java b/src/main/java/org/apache/bcel/generic/InstructionList.java
index ea283f4e..0e6f3aa0 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -1026,7 +1026,7 @@ public class InstructionList implements Iterable<InstructionHandle> {
last.setNext(null);
final List<InstructionHandle> targetList = new ArrayList<>();
for (InstructionHandle ih = first; ih != null; ih = ih.getNext()) {
- ih.getInstruction().dispose(); // e.g. BranchInstructions release their targets
+ ih.getInstruction().dispose(); // for example BranchInstructions release their targets
}
final StringBuilder buf = new StringBuilder("{ ");
for (InstructionHandle ih = first; ih != null; ih = next) {
@@ -1076,7 +1076,7 @@ public class InstructionList implements Iterable<InstructionHandle> {
/**
* Give all instructions their position number (offset in byte stream), i.e., make the list ready to be dumped.
*
- * @param check Perform sanity checks, e.g. if all targeted instructions really belong to this list
+ * @param check Perform sanity checks, for example if all targeted instructions really belong to this list
*/
public void setPositions(final boolean check) { // called by code in other packages
int maxAdditionalBytes = 0;
diff --git a/src/main/java/org/apache/bcel/generic/JSR_W.java b/src/main/java/org/apache/bcel/generic/JSR_W.java
index 416473e5..8c36ee68 100644
--- a/src/main/java/org/apache/bcel/generic/JSR_W.java
+++ b/src/main/java/org/apache/bcel/generic/JSR_W.java
@@ -66,7 +66,7 @@ public class JSR_W extends JsrInstruction {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/LDC.java b/src/main/java/org/apache/bcel/generic/LDC.java
index 5cb87335..c70db66d 100644
--- a/src/main/java/org/apache/bcel/generic/LDC.java
+++ b/src/main/java/org/apache/bcel/generic/LDC.java
@@ -122,7 +122,7 @@ public class LDC extends CPInstruction implements PushInstruction, ExceptionThro
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java b/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java
index b48b796a..f544e765 100644
--- a/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java
+++ b/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java
@@ -76,7 +76,7 @@ public class LOOKUPSWITCH extends Select {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/LoadInstruction.java b/src/main/java/org/apache/bcel/generic/LoadInstruction.java
index d9b5cb15..6a2c3b21 100644
--- a/src/main/java/org/apache/bcel/generic/LoadInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LoadInstruction.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Denotes an unparameterized instruction to load a value from a local variable, e.g. ILOAD.
+ * Denotes an unparameterized instruction to load a value from a local variable, for example ILOAD.
*/
public abstract class LoadInstruction extends LocalVariableInstruction implements PushInstruction {
@@ -33,7 +33,7 @@ public abstract class LoadInstruction extends LocalVariableInstruction implement
/**
* @param opcode Instruction opcode
- * @param cTag Instruction number for compact version, ALOAD_0, e.g.
+ * @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) {
diff --git a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
index a6f3b7e9..0ecbbf44 100644
--- a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
@@ -55,7 +55,7 @@ public abstract class LocalVariableInstruction extends Instruction implements Ty
/**
* @param opcode Instruction opcode
- * @param cTag Instruction number for compact version, ALOAD_0, e.g.
+ * @param cTag Instruction number for compact version, ALOAD_0, for example.
* @param n local variable index (unsigned short)
*/
protected LocalVariableInstruction(final short opcode, final short cTag, final int n) {
@@ -76,7 +76,7 @@ public abstract class LocalVariableInstruction extends Instruction implements Ty
out.writeByte(Const.WIDE);
}
out.writeByte(super.getOpcode());
- if (super.getLength() > 1) { // Otherwise ILOAD_n, instruction, e.g.
+ if (super.getLength() > 1) { // Otherwise ILOAD_n, instruction, for example.
if (wide()) {
out.writeShort(n);
} else {
@@ -86,7 +86,7 @@ public abstract class LocalVariableInstruction extends Instruction implements Ty
}
/**
- * @return canonical tag for instruction, e.g., ALOAD for ALOAD_0
+ * @return canonical tag for instruction, for example, ALOAD for ALOAD_0
*/
public short getCanonicalTag() {
return canonTag;
@@ -131,7 +131,7 @@ public abstract class LocalVariableInstruction extends Instruction implements Ty
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*
* <pre>
* (ILOAD <= tag <= ALOAD_3) || (ISTORE <= tag <= ASTORE_3)
diff --git a/src/main/java/org/apache/bcel/generic/MethodGen.java b/src/main/java/org/apache/bcel/generic/MethodGen.java
index 2e96ee85..cfc99d7c 100644
--- a/src/main/java/org/apache/bcel/generic/MethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/MethodGen.java
@@ -805,7 +805,7 @@ public class MethodGen extends FieldGenOrMethodGen {
LineNumberTable lnt = null;
LocalVariableTable lvt = null;
/*
- * Create LocalVariableTable and LineNumberTable attributes (for debuggers, e.g.)
+ * Create LocalVariableTable and LineNumberTable attributes (for debuggers, for example)
*/
if (!variableList.isEmpty() && !stripAttributes) {
updateLocalVariableTable(getLocalVariableTable(cp));
@@ -1113,7 +1113,7 @@ public class MethodGen extends FieldGenOrMethodGen {
/**
* Return string representation close to declaration format, 'public static void main(String[]) throws IOException',
- * e.g.
+ * for example.
*
* @return String representation of the method.
*/
diff --git a/src/main/java/org/apache/bcel/generic/NEWARRAY.java b/src/main/java/org/apache/bcel/generic/NEWARRAY.java
index 7515c2a4..f9caf55f 100644
--- a/src/main/java/org/apache/bcel/generic/NEWARRAY.java
+++ b/src/main/java/org/apache/bcel/generic/NEWARRAY.java
@@ -97,7 +97,7 @@ public class NEWARRAY extends Instruction implements AllocationInstruction, Exce
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/ObjectType.java b/src/main/java/org/apache/bcel/generic/ObjectType.java
index 2a90ffbd..d9ee9134 100644
--- a/src/main/java/org/apache/bcel/generic/ObjectType.java
+++ b/src/main/java/org/apache/bcel/generic/ObjectType.java
@@ -31,7 +31,7 @@ public class ObjectType extends ReferenceType {
/**
* Constructs a new instance.
*
- * @param className fully qualified class name, e.g. java.lang.String
+ * @param className fully qualified class name, for example java.lang.String
* @return a new instance.
* @since 6.0
*/
@@ -44,7 +44,7 @@ public class ObjectType extends ReferenceType {
/**
* Constructs a new instance.
*
- * @param className fully qualified class name, e.g. {@link String}
+ * @param className fully qualified class name, for example {@link String}
*/
public ObjectType(final String className) {
super(Const.T_REFERENCE, "L" + Utility.packageToPath(className) + ";");
diff --git a/src/main/java/org/apache/bcel/generic/RET.java b/src/main/java/org/apache/bcel/generic/RET.java
index d19d143f..b737cf85 100644
--- a/src/main/java/org/apache/bcel/generic/RET.java
+++ b/src/main/java/org/apache/bcel/generic/RET.java
@@ -92,7 +92,7 @@ public class RET extends Instruction implements IndexedInstruction, TypedInstruc
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/ReferenceType.java b/src/main/java/org/apache/bcel/generic/ReferenceType.java
index 6317e3eb..74fd4571 100644
--- a/src/main/java/org/apache/bcel/generic/ReferenceType.java
+++ b/src/main/java/org/apache/bcel/generic/ReferenceType.java
@@ -244,7 +244,7 @@ public abstract class ReferenceType extends Type {
/**
* Return true iff this type is castable to another type t as defined in the JVM specification. The case where this is
- * {@link #NULL} is not defined (see the CHECKCAST definition in the JVM specification). However, because e.g. CHECKCAST
+ * {@link #NULL} is not defined (see the CHECKCAST definition in the JVM specification). However, because for example CHECKCAST
* doesn't throw a ClassCastException when casting a null reference to any Object, true is returned in this case.
*
* @throws ClassNotFoundException if any classes or interfaces required to determine assignment compatibility can't be
diff --git a/src/main/java/org/apache/bcel/generic/SIPUSH.java b/src/main/java/org/apache/bcel/generic/SIPUSH.java
index d585b1c6..b94f206e 100644
--- a/src/main/java/org/apache/bcel/generic/SIPUSH.java
+++ b/src/main/java/org/apache/bcel/generic/SIPUSH.java
@@ -83,7 +83,7 @@ public class SIPUSH extends Instruction implements ConstantPushInstruction {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/Select.java b/src/main/java/org/apache/bcel/generic/Select.java
index 19043f44..545acede 100644
--- a/src/main/java/org/apache/bcel/generic/Select.java
+++ b/src/main/java/org/apache/bcel/generic/Select.java
@@ -222,7 +222,7 @@ public abstract class Select extends BranchInstruction implements VariableLength
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/StackProducer.java b/src/main/java/org/apache/bcel/generic/StackProducer.java
index a1219e28..6c118412 100644
--- a/src/main/java/org/apache/bcel/generic/StackProducer.java
+++ b/src/main/java/org/apache/bcel/generic/StackProducer.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Denotes an instruction that may produce a value on top of the stack (this excludes DUP_X1, e.g.)
+ * Denotes an instruction that may produce a value on top of the stack (this excludes DUP_X1, for example)
*/
public interface StackProducer {
diff --git a/src/main/java/org/apache/bcel/generic/StoreInstruction.java b/src/main/java/org/apache/bcel/generic/StoreInstruction.java
index f34e2016..f9647b08 100644
--- a/src/main/java/org/apache/bcel/generic/StoreInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/StoreInstruction.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Denotes an unparameterized instruction to store a value into a local variable, e.g. ISTORE.
+ * Denotes an unparameterized instruction to store a value into a local variable, for example ISTORE.
*/
public abstract class StoreInstruction extends LocalVariableInstruction implements PopInstruction {
@@ -33,7 +33,7 @@ public abstract class StoreInstruction extends LocalVariableInstruction implemen
/**
* @param opcode Instruction opcode
- * @param cTag Instruction number for compact version, ASTORE_0, e.g.
+ * @param cTag Instruction number for compact version, ASTORE_0, for example
* @param n local variable index (unsigned short)
*/
protected StoreInstruction(final short opcode, final short cTag, final int n) {
diff --git a/src/main/java/org/apache/bcel/generic/TABLESWITCH.java b/src/main/java/org/apache/bcel/generic/TABLESWITCH.java
index 611b2caa..960ea202 100644
--- a/src/main/java/org/apache/bcel/generic/TABLESWITCH.java
+++ b/src/main/java/org/apache/bcel/generic/TABLESWITCH.java
@@ -83,7 +83,7 @@ public class TABLESWITCH extends Select {
}
/**
- * Read needed data (e.g. index) from file.
+ * Read needed data (for example index) from file.
*/
@Override
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException {
diff --git a/src/main/java/org/apache/bcel/generic/Type.java b/src/main/java/org/apache/bcel/generic/Type.java
index 462f0844..3a1fffbf 100644
--- a/src/main/java/org/apache/bcel/generic/Type.java
+++ b/src/main/java/org/apache/bcel/generic/Type.java
@@ -31,7 +31,7 @@ import org.apache.commons.lang3.StringUtils;
/**
* Abstract super class for all possible Java types, namely basic types such as int, object types like String and array
- * types, e.g. int[]
+ * types, for example int[]
*/
public abstract class Type {
@@ -124,7 +124,7 @@ public abstract class Type {
}
/**
- * Convert type to Java method signature, e.g. int[] f(java.lang.String x) becomes (Ljava/lang/String;)[I
+ * Convert type to Java method signature, for example int[] f(java.lang.String x) becomes (Ljava/lang/String;)[I
*
* @param returnType what the method returns
* @param argTypes what are the argument types
@@ -400,7 +400,7 @@ public abstract class Type {
}
/**
- * @return Type string, e.g. 'int[]'
+ * @return Type string, for example 'int[]'
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
index 98c3ab0f..fc8f7256 100644
--- a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
@@ -29,7 +29,7 @@ import org.apache.bcel.classfile.Utility;
* This abstract class provides a logic of a loading {@link JavaClass} objects class names via {@link ClassPath}.
*
* <p>
- * Subclasses can choose caching strategy of the objects by implementing the abstract methods (e.g.,
+ * Subclasses can choose caching strategy of the objects by implementing the abstract methods (for example,
* {@link #storeClass(JavaClass)} and {@link #findClass(String)}).
* </p>
*
diff --git a/src/main/java/org/apache/bcel/util/Class2HTML.java b/src/main/java/org/apache/bcel/util/Class2HTML.java
index 9471dd15..8452350c 100644
--- a/src/main/java/org/apache/bcel/util/Class2HTML.java
+++ b/src/main/java/org/apache/bcel/util/Class2HTML.java
@@ -50,7 +50,7 @@ import org.apache.bcel.classfile.Utility;
* <LI>"package"."class"_methods.html contains references to all methods and fields of the class
* </OL>
*
- * All subfiles reference each other appropriately, e.g. clicking on a method in the Method's frame will jump to the
+ * All subfiles reference each other appropriately, for example clicking on a method in the Method's frame will jump to the
* appropriate method in the Code frame.
*/
public class Class2HTML implements Constants {
diff --git a/src/main/java/org/apache/bcel/util/ClassPath.java b/src/main/java/org/apache/bcel/util/ClassPath.java
index 4020002e..9b337ef0 100644
--- a/src/main/java/org/apache/bcel/util/ClassPath.java
+++ b/src/main/java/org/apache/bcel/util/ClassPath.java
@@ -595,7 +595,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified file name, e.g. java/lang/String
+ * @param name fully qualified file name, for example java/lang/String
* @return byte array for class
* @throws IOException if an I/O error occurs.
*/
@@ -604,8 +604,8 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified file name, e.g. java/lang/String
- * @param suffix file name ends with suffix, e.g. .java
+ * @param name fully qualified file name, for example java/lang/String
+ * @param suffix file name ends with suffix, for example .java
* @return byte array for file on class path
* @throws IOException if an I/O error occurs.
*/
@@ -627,7 +627,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified class name, e.g. java.lang.String
+ * @param name fully qualified class name, for example java.lang.String
* @return input stream for class
* @throws IOException if an I/O error occurs.
*/
@@ -636,8 +636,8 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified file name, e.g. java/lang/String
- * @param suffix file name ends with suff, e.g. .java
+ * @param name fully qualified file name, for example java/lang/String
+ * @param suffix file name ends with suff, for example .java
* @return class file for the Java class
* @throws IOException if an I/O error occurs.
*/
@@ -674,7 +674,7 @@ public class ClassPath implements Closeable {
* <p>
* The caller is responsible for closing the InputStream.
* </p>
- * @param name fully qualified class name, e.g. java.lang.String
+ * @param name fully qualified class name, for example java.lang.String
* @return input stream for class
* @throws IOException if an I/O error occurs.
*/
@@ -688,8 +688,8 @@ public class ClassPath implements Closeable {
* The caller is responsible for closing the InputStream.
* </p>
*
- * @param name fully qualified file name, e.g. java/lang/String
- * @param suffix file name ends with suff, e.g. .java
+ * @param name fully qualified file name, for example java/lang/String
+ * @param suffix file name ends with suff, for example .java
* @return input stream for file on class path
* @throws IOException if an I/O error occurs.
*/
@@ -709,7 +709,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name name of file to search for, e.g. java/lang/String.java
+ * @param name name of file to search for, for example java/lang/String.java
* @return full (canonical) path for file
* @throws IOException if an I/O error occurs.
*/
@@ -724,8 +724,8 @@ public class ClassPath implements Closeable {
}
/**
- * @param name name of file to search for, e.g. java/lang/String
- * @param suffix file name suffix, e.g. .java
+ * @param name name of file to search for, for example java/lang/String
+ * @param suffix file name suffix, for example .java
* @return full (canonical) path for file, if it exists
* @throws IOException if an I/O error occurs.
*/
@@ -734,7 +734,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified resource name, e.g. java/lang/String.class
+ * @param name fully qualified resource name, for example java/lang/String.class
* @return URL supplying the resource, or null if no resource with that name.
* @since 6.0
*/
@@ -749,7 +749,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified resource name, e.g. java/lang/String.class
+ * @param name fully qualified resource name, for example java/lang/String.class
* @return InputStream supplying the resource, or null if no resource with that name.
* @since 6.0
*/
@@ -764,7 +764,7 @@ public class ClassPath implements Closeable {
}
/**
- * @param name fully qualified resource name, e.g. java/lang/String.class
+ * @param name fully qualified resource name, for example java/lang/String.class
* @return An Enumeration of URLs supplying the resource, or an empty Enumeration if no resource with that name.
* @since 6.0
*/
diff --git a/src/main/java/org/apache/bcel/util/CodeHTML.java b/src/main/java/org/apache/bcel/util/CodeHTML.java
index 6412ca1e..7a2211df 100644
--- a/src/main/java/org/apache/bcel/util/CodeHTML.java
+++ b/src/main/java/org/apache/bcel/util/CodeHTML.java
@@ -526,7 +526,7 @@ final class CodeHTML {
}
printWriter.println("</UL>");
}
- if (code != null) { // No code, an abstract method, e.g.
+ if (code != null) { // No code, an abstract method, for example
// System.out.println(name + "\n" + Utility.codeToString(code, constantPool, 0, -1));
// Print the byte code
try (ByteSequence stream = new ByteSequence(code)) {
diff --git a/src/main/java/org/apache/bcel/util/InstructionFinder.java b/src/main/java/org/apache/bcel/util/InstructionFinder.java
index fd32dff7..ae8a9376 100644
--- a/src/main/java/org/apache/bcel/util/InstructionFinder.java
+++ b/src/main/java/org/apache/bcel/util/InstructionFinder.java
@@ -35,7 +35,7 @@ import org.apache.bcel.generic.InstructionList;
/**
* InstructionFinder is a tool to search for given instructions patterns, i.e., match sequences of instructions in an
- * instruction list via regular expressions. This can be used, e.g., in order to implement a peep hole optimizer that
+ * instruction list via regular expressions. This can be used, for example, in order to implement a peep hole optimizer that
* looks for code patterns and replaces them with faster equivalents.
*
* <p>
@@ -263,7 +263,7 @@ public class InstructionFinder {
}
/**
- * Reread the instruction list, e.g., after you've altered the list upon a match.
+ * Reread the instruction list, for example, after you've altered the list upon a match.
*/
public final void reread() {
final int size = il.getLength();
@@ -309,8 +309,8 @@ public class InstructionFinder {
}
/**
- * Search for the given pattern in the instruction list. You can search for any valid opcode via its symbolic name, e.g.
- * "istore". You can also use a super class or an interface name to match a whole set of instructions, e.g.
+ * Search for the given pattern in the instruction list. You can search for any valid opcode via its symbolic name, for example
+ * "istore". You can also use a super class or an interface name to match a whole set of instructions, for example
* "BranchInstruction" or "LoadInstruction". "istore" is also an alias for all "istore_x" instructions. Additional
* aliases are "if" for "ifxx", "if_icmp" for "if_icmpxx", "if_acmp" for "if_acmpxx".
*
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java b/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java
index 0cebf217..c5f95946 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass1Verifier.java
@@ -85,8 +85,8 @@ public final class Pass1Verifier extends PassVerifier {
* the actually size of the attribute content should be uncovered. For example, in an Exceptions attribute, the actual
* number of exceptions as required by the number_of_exceptions field might yeild an attribute size that doesn't match
* the attribute_length. Such an anomaly should be detected.
- * <LI>all attributes should have proper length. In particular, under certain context (e.g. while parsing method_info),
- * recognizable attributes (e.g. "Code" attribute) should have correct format (e.g. attribute_length is 2).
+ * <LI>all attributes should have proper length. In particular, under certain context (for example while parsing method_info),
+ * recognizable attributes (for example "Code" attribute) should have correct format (for example attribute_length is 2).
* </UL>
* <LI>Also, certain constant values are checked for validity:
* <UL>
@@ -140,7 +140,7 @@ public final class Pass1Verifier extends PassVerifier {
} catch (final LoadingException | ClassFormatException e) {
return new VerificationResult(VerificationResult.VERIFIED_REJECTED, e.getMessage());
} catch (final RuntimeException e) {
- // BCEL does not catch every possible RuntimeException; e.g. if
+ // BCEL does not catch every possible RuntimeException; for example if
// a constant pool index is referenced that does not exist.
return new VerificationResult(VerificationResult.VERIFIED_REJECTED, "Parsing via BCEL did not succeed. " + " exception occurred:\n" + e.toString());
// Don't think we want to dump a stack trace unless we have some sort of a debug option.
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 deeb8eb6..5705cb2a 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
@@ -613,7 +613,7 @@ public final class Pass3aVerifier extends PassVerifier {
// too. So are the allowed method names.
final String className = o.getClassName(constantPoolGen);
final JavaClass jc;
- if (className.charAt(0) == '[') { // array type, e.g. invoke can be someArray.clone()
+ if (className.charAt(0) == '[') { // array type, for example invoke can be someArray.clone()
jc = Repository.lookupClass("java.lang.Object");
} else {
jc = Repository.lookupClass(className);
diff --git a/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java b/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
index 9a2cc1a6..c5435d71 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/StringRepresentation.java
@@ -74,7 +74,7 @@ import org.apache.bcel.verifier.exc.AssertionViolatedException;
/**
* BCEL's Node classes (those from the classfile API that <B>accept()</B> Visitor instances) have <B>toString()</B>
* methods that were not designed to be robust, this gap is closed by this class. When performing class file
- * verification, it may be useful to output which entity (e.g. a <B>Code</B> instance) is not satisfying the verifier's
+ * verification, it may be useful to output which entity (for example a <B>Code</B> instance) is not satisfying the verifier's
* constraints, but in this case it could be possible for the <B>toString()</B> method to throw a RuntimeException. A
* (new StringRepresentation(Node n)).toString() never throws any exception. Note that this class also serves as a
* placeholder for more sophisticated message handling in future versions of JustIce.
@@ -168,7 +168,7 @@ public class StringRepresentation extends org.apache.bcel.classfile.EmptyVisitor
// Visitor methods start here //
////////////////////////////////
// We don't of course need to call some default implementation:
- // e.g. we could also simply output "Code" instead of a possibly
+ // for example we could also simply output "Code" instead of a possibly
// lengthy Code attribute's toString().
@Override
public void visitCode(final Code obj) {
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 2a8a42a1..b1323163 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
@@ -341,7 +341,7 @@ public class ControlFlowGraph {
*/
@Override
public String toString() {
- // TODO: Put information in the brackets, e.g.
+ // TODO: Put information in the brackets, for example
// Is this an ExceptionHandler? Is this a RET? Is this the start of
// a subroutine?
return getInstruction().toString(false) + "\t[InstructionContext]";
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 73cdca6b..d9aba376 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
@@ -2360,7 +2360,7 @@ public class InstConstraintVisitor extends EmptyVisitor {
}
final ObjectType obj = (ObjectType) t;
- // e.g.: Don't instantiate interfaces
+ // for example: Don't instantiate interfaces
try {
if (!obj.referencesClassExact()) {
constraintViolated(o, "Expecting a class type (ObjectType) to work on. Found: '" + obj + "'.");
diff --git a/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java b/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
index 8842e9c7..e209e1ed 100644
--- a/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
+++ b/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
@@ -132,7 +132,7 @@ public class JdkGenericDumpTestCase {
// System.out.println("Method: " + m);
final Code code = method.getCode();
if (code == null) {
- return; // e.g. abstract method
+ return; // for example abstract method
}
final byte[] src = code.getCode();
final InstructionList instructionList = new InstructionList(src);