This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git
The following commit(s) were added to refs/heads/master by this push:
new d133737f Javadoc
d133737f is described below
commit d133737fb3ea8cae4901897c6ffd1b275e7422d9
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Oct 30 07:09:12 2026 -0400
Javadoc
---
CONTRIBUTING.md | 2 +-
docs/verifier/JustIce.lyx | 64 +++++++++++-----------
src/conf/pmd-ruleset.xml | 2 +-
src/examples/Mini/ASTExpr.java | 4 +-
src/examples/Mini/README | 4 +-
.../org/apache/bcel/classfile/AccessFlags.java | 2 +-
.../apache/bcel/classfile/AnnotationDefault.java | 2 +-
.../org/apache/bcel/classfile/AnnotationEntry.java | 2 +-
.../org/apache/bcel/classfile/Annotations.java | 4 +-
.../java/org/apache/bcel/classfile/Attribute.java | 2 +-
src/main/java/org/apache/bcel/classfile/Code.java | 2 +-
.../org/apache/bcel/classfile/CodeException.java | 2 +-
.../java/org/apache/bcel/classfile/Constant.java | 2 +-
.../org/apache/bcel/classfile/ConstantClass.java | 2 +-
.../org/apache/bcel/classfile/ConstantDouble.java | 2 +-
.../org/apache/bcel/classfile/ConstantDynamic.java | 4 +-
.../apache/bcel/classfile/ConstantFieldref.java | 2 +-
.../org/apache/bcel/classfile/ConstantFloat.java | 2 +-
.../org/apache/bcel/classfile/ConstantInteger.java | 2 +-
.../bcel/classfile/ConstantInterfaceMethodref.java | 2 +-
.../bcel/classfile/ConstantInvokeDynamic.java | 4 +-
.../org/apache/bcel/classfile/ConstantLong.java | 2 +-
.../bcel/classfile/ConstantMethodHandle.java | 4 +-
.../apache/bcel/classfile/ConstantMethodType.java | 4 +-
.../apache/bcel/classfile/ConstantMethodref.java | 2 +-
.../org/apache/bcel/classfile/ConstantModule.java | 4 +-
.../apache/bcel/classfile/ConstantNameAndType.java | 2 +-
.../org/apache/bcel/classfile/ConstantPackage.java | 4 +-
.../org/apache/bcel/classfile/ConstantPool.java | 8 +--
.../org/apache/bcel/classfile/ConstantString.java | 2 +-
.../org/apache/bcel/classfile/ConstantUtf8.java | 2 +-
.../org/apache/bcel/classfile/ConstantValue.java | 2 +-
.../java/org/apache/bcel/classfile/Deprecated.java | 2 +-
.../apache/bcel/classfile/DescendingVisitor.java | 2 +-
src/main/java/org/apache/bcel/classfile/Field.java | 2 +-
.../java/org/apache/bcel/classfile/InnerClass.java | 2 +-
.../org/apache/bcel/classfile/InnerClasses.java | 2 +-
.../java/org/apache/bcel/classfile/JavaClass.java | 2 +-
.../java/org/apache/bcel/classfile/LineNumber.java | 2 +-
.../org/apache/bcel/classfile/LineNumberTable.java | 2 +-
.../org/apache/bcel/classfile/LocalVariable.java | 2 +-
.../apache/bcel/classfile/LocalVariableTable.java | 2 +-
.../java/org/apache/bcel/classfile/Method.java | 2 +-
.../java/org/apache/bcel/classfile/Module.java | 2 +-
.../org/apache/bcel/classfile/ModuleExports.java | 2 +-
.../org/apache/bcel/classfile/ModuleMainClass.java | 4 +-
.../org/apache/bcel/classfile/ModuleOpens.java | 2 +-
.../org/apache/bcel/classfile/ModulePackages.java | 2 +-
.../org/apache/bcel/classfile/ModuleProvides.java | 2 +-
.../org/apache/bcel/classfile/ModuleRequires.java | 2 +-
.../java/org/apache/bcel/classfile/NestHost.java | 2 +-
.../org/apache/bcel/classfile/NestMembers.java | 2 +-
.../java/org/apache/bcel/classfile/PMGClass.java | 2 +-
.../bcel/classfile/ParameterAnnotationEntry.java | 2 +-
.../bcel/classfile/ParameterAnnotations.java | 2 +-
.../apache/bcel/classfile/PermittedSubclasses.java | 2 +-
.../java/org/apache/bcel/classfile/Record.java | 2 +-
.../java/org/apache/bcel/classfile/Signature.java | 2 +-
.../java/org/apache/bcel/classfile/SourceFile.java | 2 +-
.../java/org/apache/bcel/classfile/StackMap.java | 2 +-
.../org/apache/bcel/classfile/StackMapEntry.java | 2 +-
.../org/apache/bcel/classfile/StackMapType.java | 2 +-
.../java/org/apache/bcel/classfile/Synthetic.java | 4 +-
.../apache/bcel/classfile/TypeAnnotationEntry.java | 6 +-
.../java/org/apache/bcel/classfile/Unknown.java | 2 +-
.../java/org/apache/bcel/classfile/Utility.java | 4 +-
.../java/org/apache/bcel/classfile/Visitor.java | 2 +-
.../org/apache/bcel/generic/CPInstruction.java | 2 +-
.../java/org/apache/bcel/generic/ClassGen.java | 2 +-
.../bcel/generic/ConstantPushInstruction.java | 2 +-
.../java/org/apache/bcel/generic/FieldGen.java | 4 +-
.../apache/bcel/generic/IndexedInstruction.java | 2 +-
.../apache/bcel/generic/InstructionComparator.java | 6 +-
.../org/apache/bcel/generic/InstructionConst.java | 9 ++-
.../apache/bcel/generic/InstructionConstants.java | 9 ++-
.../apache/bcel/generic/InstructionFactory.java | 2 +-
.../org/apache/bcel/generic/InstructionList.java | 2 +-
.../java/org/apache/bcel/generic/MethodGen.java | 2 +-
.../org/apache/bcel/generic/PushInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/SWITCH.java | 6 +-
src/main/java/org/apache/bcel/generic/Select.java | 2 +-
.../apache/bcel/generic/TargetLostException.java | 2 +-
src/main/java/org/apache/bcel/generic/Visitor.java | 2 +-
.../bcel/util/AbstractClassPathRepository.java | 2 +-
src/main/java/org/apache/bcel/util/ClassPath.java | 7 ++-
src/main/java/org/apache/bcel/util/CodeHTML.java | 4 +-
.../java/org/apache/bcel/util/ConstantHTML.java | 6 +-
.../org/apache/bcel/util/InstructionFinder.java | 2 +-
.../structurals/InstConstraintVisitor.java | 4 +-
src/site/markdown/security.md | 2 +-
src/site/xdoc/faq.xml | 10 ++--
src/site/xdoc/index.xml | 21 +++++--
src/site/xdoc/manual/appendix.xml | 37 +++++++------
src/site/xdoc/manual/application-areas.xml | 11 ++--
src/site/xdoc/manual/bcel-api.xml | 41 +++++++-------
src/site/xdoc/manual/jvm.xml | 38 +++++++------
.../bcel/classfile/TypeAnnotationEntryTest.java | 6 ++
.../java/org/apache/bcel/data/ConstantPoolX.java | 2 +-
.../org/apache/bcel/generic/MethodGenTest.java | 4 +-
99 files changed, 253 insertions(+), 230 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 205093b7..86cfbe8f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,7 +61,7 @@ Making Changes
+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch from the `master` branch.
- * A good topic branch name can be the JIRA bug ID plus a keyword, e.g.
`BCEL-123-InputStream`.
+ * A good topic branch name can be the JIRA bug ID plus a keyword, for
example `BCEL-123-InputStream`.
* If you have submitted multiple JIRA issues, try to maintain separate
branches and pull requests.
+ Make commits of logical units.
* Make sure your commit messages are meaningful and in the proper format.
Your commit message should contain the key of the JIRA issue.
diff --git a/docs/verifier/JustIce.lyx b/docs/verifier/JustIce.lyx
index 4755a857..ef9e3365 100644
--- a/docs/verifier/JustIce.lyx
+++ b/docs/verifier/JustIce.lyx
@@ -405,8 +405,8 @@ ce from operating systems and concrete hardware.
use the JVM bytecode as target.
\layout Standard
-Nowadays, many other programming languages do have the JVM as its target
- platform; e.g.
+Nowadays, many other programming languages have the JVM as their target
+ platform, for example
Fortran
\begin_inset LatexCommand \cite{f2j}
@@ -983,7 +983,7 @@ As we will see, the
ClassFile
\family default
structure and its sub-structures are defined for upwards compatibility,
- i.e., new structure definitions can be added to the specification easily
+ that is, new structure definitions can be added to the specification easily
at a later time.
\newline
@@ -1082,7 +1082,7 @@ You may read an '
\family typewriter
u
\family default
-' as 'byte times'; e.g., '
+' as 'byte times'. For example, '
\family typewriter
u2
\family default
@@ -1383,7 +1383,7 @@ attribute_info attributes[attributes_count];
\newline
This is the most complex of all predefined attributes.
- Every method that has code (i.e., every non-native, non-abstract method)
+ Every method that has code (that is, every non-native, non-abstract method)
must have such an attribute.
Note that the maximum stack depth and the number of local variables for
a method invocation are defined here.
@@ -1628,7 +1628,7 @@ The most important item, however, is the
code
\family default
item.
- It defines the bytecode of this method; i.e., the JVM machine instructions.
+ It defines the bytecode of this method, that is, the JVM machine instructions.
\layout Subsubsection
@@ -1858,7 +1858,7 @@ u1 bytes[length];
\family default
A CONSTANT_Utf8 represents a constant string.
- Such a string is e.g.
+ Such a string is, for example,
used to describe names of methods, names of fields, names of attributes,
types of methods or types of fields.
This string is encoded in UTF-8 format, a variant of the unicode character
@@ -2052,7 +2052,7 @@ A field has to be unique in a class file with respect to
its name and descriptor
\layout Standard
The descriptor of a field describes its type.
- E.g., a descriptor of
+ For example, a descriptor of
\begin_inset Quotes eld
\end_inset
@@ -2105,7 +2105,7 @@ visibility
.
\end_float
of the field.
- E.g., a field with the
+ For example, a field with the
\family typewriter
ACC_PRIVATE
\begin_float footnote
@@ -2474,7 +2474,7 @@ operations: Constants can be pushed onto the stack either
by loading
texttt{ldc}
\latex default
instruction or with special ``short-cut'' instructions where the operand
- is encoded into the instructions, e.g.,
+ is encoded into the instructions, for example,
\latex latex
\backslash
@@ -2501,13 +2501,13 @@ operations: The instruction set of the JVM
distinguishes its operand
texttt{i}
\latex default
, for example, denote an integer operation.
- E.g.,
+ For example,
\latex latex
\backslash
texttt{iadd}
\latex default
- that adds two integers and pushes the result back on the operand stack.
+ adds two integers and pushes the result back on the operand stack.
The Java types
\latex latex
@@ -2629,7 +2629,7 @@ texttt{athrow}
\latex default
instruction.
Branch targets are coded as offsets from the current byte code position,
- i.e., they are coded with an integer number.
+ that is, they are coded with an integer number.
\layout Description
Load\SpecialChar ~
@@ -2830,7 +2830,7 @@ bytecode
The JVM is a stack-based machine.
There are local variables which may be compared to registers, but most
instructions work on the operand stack.
- E.g., the
+ For example, the
\latex latex
\backslash
@@ -6228,7 +6228,7 @@ this attribute has a length of 1234 bytes in total
Resolution
\emph default
is the transformation of a symbolic reference to an actual reference --
- i.e., as long as there is only a symbolic reference to an entity, this entity
+ that is, as long as there is only a symbolic reference to an entity, this
entity
cannot be verified at all because it has not been loaded yet.
Passes two and three are performed during the
\emph on
@@ -6329,7 +6329,7 @@ This performance enhancement has an ugly side effect.
\emph on
used
\emph default
-, i.e.,
+, that is,
\emph on
resolved
\emph default
@@ -7148,7 +7148,7 @@ Reachability of Instructions
\layout Standard
For the data flow analysis algorithm, you need to know all the possible
- control flow successors of every instruction, i.e., you need to build a
+ control flow successors of every instruction, that is, you need to build a
\emph on
control flow graph
\emph default
@@ -7768,7 +7768,7 @@ texttt{ret}
\emph on
N
\emph default
-; i.e., it is a
+; that is, it is a
\latex latex
\backslash
@@ -8602,7 +8602,7 @@ The Byte Code Engineering Library (BCEL) presents an
object oriented view
JustIce uses the BCEL, so there was nothing left to do to load a class
file in.
Only minor changes were made to the BCEL to make it more verbose when
exception
-al situations occur; i.e., when a garbled class file is loaded in.
+al situations occur, that is, when a garbled class file is loaded in.
The BCEL uses Java's exception mechanism to signal these situations; JustIce
transforms this behavior into the behavior expected by users of the Verificat
ion API (see section
@@ -8670,7 +8670,7 @@ all verification that can be performed without looking at
the bytecodes
For some reasons (like determining a valid ancestor hierarchy of a class),
pass two of JustIce has to load referenced classes.
Of course, this is done in a careful way: by pass-one-verifying them.
- If loading of a referenced class should fail (i.e., verification pass one
+ If loading of a referenced class should fail (that is, verification pass one
fails on this class), the referencing class is rejected by JustIce's pass
two.
Pass two of JustIce does not pass-two-verify any referenced classes.
@@ -8896,7 +8896,7 @@ trustful
\begin_inset Quotes erd
\end_inset
- when parsing, i.e., where BCEL relies on the correctness of the class file.
+ when parsing, that is, where BCEL relies on the correctness of the class file.
\layout Standard
Pass 3a consists of the checking of static constraints on instructions and
@@ -9946,7 +9946,7 @@ Comparison to Sun's Implementation
JustIce was originally aimed to be as compatible to Sun's implementation
as possible.
However, the unclear specification prevents clean room implementations
- (i.e., implementations whose programmers did not look into Sun's code) from
+ (that is, implementations whose programmers did not look into Sun's code) from
perfect compatibility.
\layout Standard
@@ -9958,7 +9958,7 @@ de.fub.bytecode.verifier.Verifier
\emph default
class.
This set includes most of the classes of the Java 2 API supplied by Sun
- Microsystems, i.e., a few hundreds of apparently correct classes.
+ Microsystems, that is, a few hundred apparently correct classes.
A very small number of class files was rejected by JustIce because of its
different specification of subroutine constraints.
No other rejects were encountered.
@@ -10144,7 +10144,7 @@ VerificationResult
.
\layout Standard
-All class files are fetched from the BCEL's class file repository, i.e., the
+All class files are fetched from the BCEL's class file repository, that is, the
class
\family typewriter
Re\SpecialChar \-
@@ -10269,9 +10269,9 @@ A Verifier creates instances of PassVerifiers.
A PassVerifier instance in charge of performing some later verification
pass transparently creates PassVerifier instances for the preceding passes.
Therefore, users of the Verification API do not have to care about the
- order of verification passes; i.e., earlier passes are run always before
+ order of verification passes; that is, earlier passes are always run before
later passes.
- All verification results are cached; this way an unsual order of calls
+ All verification results are cached; this way an unusual order of calls
to the
\emph on
doPassX()
@@ -11069,7 +11069,7 @@ What Was Achieved
\layout Standard
About a third of the development time of JustIce was spent examining the
- various issues in connection with subroutines, i.e., issues concerning the
+ various issues in connection with subroutines, that is, issues concerning the
bytecode instructions
\latex latex
@@ -11220,7 +11220,7 @@ While this might be possible in some cases, in general
the constraints of
data flow analyzer in a sane way.
As another example, if a user preferred not to care about stack underflow
the verification algorithm would require complicated user interaction;
- i.e., the user would have to decide what type to put onto the simulated
operand
+ that is, the user would have to decide what type to put onto the simulated
operand
stack just before it is read.
\layout Standard
@@ -11462,7 +11462,7 @@ This code is harmless, because lines 6 and 7 can never
be executed (it would
We conclude that there cannot be a perfect verifier.
All that could be done is reduce the degree of uncertainty.
- For practical purposes, i.e., to be compatible with Sun's implementation,
+ For practical purposes, that is, to be compatible with Sun's implementation,
one should not even do that.
\layout Standard
@@ -11640,7 +11640,7 @@ interface}
).
\layout Standard
-St�rk et al.
+St�rk and colleagues
suggest the use of
\emph on
sets
@@ -11843,7 +11843,7 @@ LocalVariableTable
\layout Standard
JustIce builds data structures to warn if it detects contradicting and
overlappi
-ng areas; e.g., if some local variable is anounced to carry an
+ng areas; for example, if some local variable is announced to carry an
\family typewriter
int
\family default
@@ -12502,7 +12502,7 @@ javac
compiler may create class files with a '$' character in their names as
a result of Java source files defining inner classes, this character should
no longer be a valid part of a Java name to avoid problems.
- I.e., the method invocation
+ That is, the method invocation
\emph on
ja\SpecialChar \-
va.lang.Cha\SpecialChar \-
diff --git a/src/conf/pmd-ruleset.xml b/src/conf/pmd-ruleset.xml
index 6b8b0982..2cdceb57 100644
--- a/src/conf/pmd-ruleset.xml
+++ b/src/conf/pmd-ruleset.xml
@@ -66,7 +66,7 @@
<rule ref="category/java/codestyle.xml/UnnecessaryFullyQualifiedName">
<properties>
<!-- java.lang annotations have the same name as BCEL classes so must be
fully
- qualified, e.g. java.lang.Deprecated -->
+ qualified, for example java.lang.Deprecated -->
<property name="violationSuppressXPath"
value="//ClassOrInterfaceDeclaration[@SimpleName='AccessFlags' or
@SimpleName='Attribute'
or @SimpleName='AttributeReader' or @SimpleName='Constant'
diff --git a/src/examples/Mini/ASTExpr.java b/src/examples/Mini/ASTExpr.java
index 114ebdc2..73f55425 100644
--- a/src/examples/Mini/ASTExpr.java
+++ b/src/examples/Mini/ASTExpr.java
@@ -43,7 +43,7 @@ import org.apache.bcel.generic.PUSH;
*
* A node with kind == -1 denotes the fact that this expression node has just
one child branch and thus may be replaced
* by this branch (or leaf) directly without altering the expression
semantics. Term and Factor nodes are used only to
- * build the parse tree obeying the arithmetical precedences (* stronger than
+, etc.) and are discarded in the first
+ * build the parse tree obeying the arithmetical precedences (* stronger than
+, and so on) and are discarded in the first
* pass.
*/
public class ASTExpr extends SimpleNode implements MiniParserConstants,
MiniParserTreeConstants {
@@ -313,7 +313,7 @@ public class ASTExpr extends SimpleNode implements
MiniParserConstants, MiniPars
childType = type = Const.T_INT;
} else if (kind == AND || kind == OR) {
childType = type = Const.T_BOOLEAN;
- } else { // LEQ, GT, etc.
+ } else { // LEQ, GT, and so on.
childType = Const.T_INT;
type = Const.T_BOOLEAN;
}
diff --git a/src/examples/Mini/README b/src/examples/Mini/README
index 69f6b3ec..fb43aad6 100644
--- a/src/examples/Mini/README
+++ b/src/examples/Mini/README
@@ -30,7 +30,7 @@ Mini uses the JavaCC parser generator which comes precompiled
from
http://www.webgain.com/products/java_cc/
After setting the CLASSPATH to the directory just above the Mini
-directory, e.g.
+directory, for example
% cd Mini
% setenv CLASSPATH $CLASSPATH:.:..
@@ -46,7 +46,7 @@ This produces a Java class file (max.class) which you can
execute with
Enter a number (for example, 4) and you will be asked to enter 4 numbers. The
program will then tell you the biggest of them.
-Alternatively you can produce a Java file (max.java) which will be
+Alternatively, you can produce a Java file (max.java) which will be
translated automatically to a .class file.
% java Mini.MiniC -java max.mini
diff --git a/src/main/java/org/apache/bcel/classfile/AccessFlags.java
b/src/main/java/org/apache/bcel/classfile/AccessFlags.java
index 95a2bd9d..1e7f1402 100644
--- a/src/main/java/org/apache/bcel/classfile/AccessFlags.java
+++ b/src/main/java/org/apache/bcel/classfile/AccessFlags.java
@@ -21,7 +21,7 @@ package org.apache.bcel.classfile;
import org.apache.bcel.Const;
/**
- * Superclass for all objects that have modifiers like private, final, ...
I.e. classes, fields, and methods.
+ * Superclass for objects that have modifiers such as private and final,
including classes, fields, and methods.
*/
public abstract class AccessFlags {
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
index 379056cb..f987f544 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
@@ -60,7 +60,7 @@ public class AnnotationDefault extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
index 59b4dd00..6a326900 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
@@ -111,7 +111,7 @@ public class AnnotationEntry implements Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Annotations.java
b/src/main/java/org/apache/bcel/classfile/Annotations.java
index bc5923d6..308f56c1 100644
--- a/src/main/java/org/apache/bcel/classfile/Annotations.java
+++ b/src/main/java/org/apache/bcel/classfile/Annotations.java
@@ -77,8 +77,8 @@ public abstract class Annotations extends Attribute
implements Iterable<Annotati
/**
* Called by objects that are traversing the nodes of the tree implicitly
- * defined by the contents of a Java class. I.e., the hierarchy of methods,
- * fields, attributes, etc. spawns a tree of objects.
+ * defined by the contents of a Java class. That is, the hierarchy of
methods,
+ * fields, attributes, and other elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Attribute.java
b/src/main/java/org/apache/bcel/classfile/Attribute.java
index 526a923c..2cb0434f 100644
--- a/src/main/java/org/apache/bcel/classfile/Attribute.java
+++ b/src/main/java/org/apache/bcel/classfile/Attribute.java
@@ -327,7 +327,7 @@ public abstract class Attribute implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Code.java
b/src/main/java/org/apache/bcel/classfile/Code.java
index 65c5e3ed..7b972c11 100644
--- a/src/main/java/org/apache/bcel/classfile/Code.java
+++ b/src/main/java/org/apache/bcel/classfile/Code.java
@@ -147,7 +147,7 @@ public final class Code extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * That is, the hierarchy of methods, fields, attributes, etc. spawns a
tree of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/CodeException.java
b/src/main/java/org/apache/bcel/classfile/CodeException.java
index 701fa9b1..bea1e08d 100644
--- a/src/main/java/org/apache/bcel/classfile/CodeException.java
+++ b/src/main/java/org/apache/bcel/classfile/CodeException.java
@@ -112,7 +112,7 @@ public final class CodeException implements Cloneable,
Node, Constants {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Constant.java
b/src/main/java/org/apache/bcel/classfile/Constant.java
index 56a3750e..aabebba6 100644
--- a/src/main/java/org/apache/bcel/classfile/Constant.java
+++ b/src/main/java/org/apache/bcel/classfile/Constant.java
@@ -136,7 +136,7 @@ public abstract class Constant implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantClass.java
b/src/main/java/org/apache/bcel/classfile/ConstantClass.java
index 24cb44c6..6785e58d 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantClass.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantClass.java
@@ -64,7 +64,7 @@ public final class ConstantClass extends Constant implements
ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantDouble.java
b/src/main/java/org/apache/bcel/classfile/ConstantDouble.java
index 411790f4..2ace5354 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantDouble.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantDouble.java
@@ -64,7 +64,7 @@ public final class ConstantDouble extends Constant implements
ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java
b/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java
index 18ed3053..7f68768c 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java
@@ -64,8 +64,8 @@ public final class ConstantDynamic extends ConstantCP {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java
b/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java
index d19a1530..f30eb5dd 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java
@@ -59,7 +59,7 @@ public final class ConstantFieldref extends ConstantCP {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of Fields, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantFloat.java
b/src/main/java/org/apache/bcel/classfile/ConstantFloat.java
index 941cf4c8..0ae6aabb 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantFloat.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantFloat.java
@@ -65,7 +65,7 @@ public final class ConstantFloat extends Constant implements
ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantInteger.java
b/src/main/java/org/apache/bcel/classfile/ConstantInteger.java
index 9800ceb2..0cab1b2b 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantInteger.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantInteger.java
@@ -64,7 +64,7 @@ public final class ConstantInteger extends Constant
implements ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git
a/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java
b/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java
index 91d9c99c..0af9812c 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java
@@ -59,7 +59,7 @@ public final class ConstantInterfaceMethodref extends
ConstantCP {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java
b/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java
index 87b1895e..08ac0a06 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java
@@ -63,8 +63,8 @@ public final class ConstantInvokeDynamic extends ConstantCP {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantLong.java
b/src/main/java/org/apache/bcel/classfile/ConstantLong.java
index 3e9df52d..23b19f89 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantLong.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantLong.java
@@ -64,7 +64,7 @@ public final class ConstantLong extends Constant implements
ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
index bdc1fd0e..7aab0d25 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
@@ -67,8 +67,8 @@ public final class ConstantMethodHandle extends Constant {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
index c72a5f9f..b0c887a6 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
@@ -64,8 +64,8 @@ public final class ConstantMethodType extends Constant {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java
b/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java
index 215333df..195a78b8 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java
@@ -59,7 +59,7 @@ public final class ConstantMethodref extends ConstantCP {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*.
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantModule.java
b/src/main/java/org/apache/bcel/classfile/ConstantModule.java
index 9bc7d6d5..83e875d2 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantModule.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantModule.java
@@ -68,8 +68,8 @@ public final class ConstantModule extends Constant implements
ConstantObject {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java
b/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java
index 58b4f55a..54ba2046 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java
@@ -68,7 +68,7 @@ public final class ConstantNameAndType extends Constant {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantPackage.java
b/src/main/java/org/apache/bcel/classfile/ConstantPackage.java
index ed340f95..f63e2c05 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantPackage.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantPackage.java
@@ -68,8 +68,8 @@ public final class ConstantPackage extends Constant
implements ConstantObject {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantPool.java
b/src/main/java/org/apache/bcel/classfile/ConstantPool.java
index 3beef94d..a5be8c1a 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantPool.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantPool.java
@@ -105,8 +105,8 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e., the hierarchy of methods, fields,
- * attributes, etc. spawns a tree of objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is, the hierarchy of methods,
fields,
+ * attributes, and other elements forms a tree of objects.
*
* @param v Visitor object.
*/
@@ -366,8 +366,8 @@ public class ConstantPool implements Cloneable, Node,
Iterable<Constant> {
}
/**
- * Gets string from constant pool and bypass the indirection of
'ConstantClass' and 'ConstantString' objects. I.e. these classes have an index
field that
- * points to another entry of the constant pool of type 'ConstantUtf8'
which contains the real data.
+ * Gets a string from the constant pool and bypasses the indirection of
'ConstantClass' and 'ConstantString' objects. These classes have an index field
+ * that points to another entry of the constant pool of type
'ConstantUtf8' which contains the real data.
*
* @param index Index in constant pool.
* @param tag Tag of expected constant, either ConstantClass or
ConstantString.
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantString.java
b/src/main/java/org/apache/bcel/classfile/ConstantString.java
index 6b145289..516ebb57 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantString.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantString.java
@@ -64,7 +64,7 @@ public final class ConstantString extends Constant implements
ConstantObject {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
index b38f32f5..83de2eb8 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
@@ -226,7 +226,7 @@ public final class ConstantUtf8 extends Constant {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantValue.java
b/src/main/java/org/apache/bcel/classfile/ConstantValue.java
index c3657cb6..f4d69822 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantValue.java
@@ -81,7 +81,7 @@ public final class ConstantValue extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Deprecated.java
b/src/main/java/org/apache/bcel/classfile/Deprecated.java
index 7b10cee0..3379b26b 100644
--- a/src/main/java/org/apache/bcel/classfile/Deprecated.java
+++ b/src/main/java/org/apache/bcel/classfile/Deprecated.java
@@ -80,7 +80,7 @@ public final class Deprecated extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is, the hierarchy of methods,
- * fields, attributes, etc. spawns a tree of objects.
+ * fields, attributes, and other elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
b/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
index b1e49a48..6fadac04 100644
--- a/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
+++ b/src/main/java/org/apache/bcel/classfile/DescendingVisitor.java
@@ -26,7 +26,7 @@ import org.apache.commons.lang3.stream.Streams;
/**
* Traverses a JavaClass with another Visitor object 'piggy-backed' that is
applied to all components of a JavaClass
- * object. I.e. this class supplies the traversal strategy, other classes can
make use of it.
+ * object. This class supplies the traversal strategy, which other classes can
use.
*/
public class DescendingVisitor implements Visitor {
private final JavaClass clazz;
diff --git a/src/main/java/org/apache/bcel/classfile/Field.java
b/src/main/java/org/apache/bcel/classfile/Field.java
index f7c5cd97..fca1bd8a 100644
--- a/src/main/java/org/apache/bcel/classfile/Field.java
+++ b/src/main/java/org/apache/bcel/classfile/Field.java
@@ -105,7 +105,7 @@ public final class Field extends FieldOrMethod {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/InnerClass.java
b/src/main/java/org/apache/bcel/classfile/InnerClass.java
index d0b592ab..9a1542c5 100644
--- a/src/main/java/org/apache/bcel/classfile/InnerClass.java
+++ b/src/main/java/org/apache/bcel/classfile/InnerClass.java
@@ -73,7 +73,7 @@ public final class InnerClass implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/InnerClasses.java
b/src/main/java/org/apache/bcel/classfile/InnerClasses.java
index 8a6aab0b..7c1745ec 100644
--- a/src/main/java/org/apache/bcel/classfile/InnerClasses.java
+++ b/src/main/java/org/apache/bcel/classfile/InnerClasses.java
@@ -87,7 +87,7 @@ public final class InnerClasses extends Attribute implements
Iterable<InnerClass
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java
b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index 77d07a36..825496a2 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -255,7 +255,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/LineNumber.java
b/src/main/java/org/apache/bcel/classfile/LineNumber.java
index e1cdc917..4f251779 100644
--- a/src/main/java/org/apache/bcel/classfile/LineNumber.java
+++ b/src/main/java/org/apache/bcel/classfile/LineNumber.java
@@ -72,7 +72,7 @@ public final class LineNumber implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
index 9cb7667f..119c0fea 100644
--- a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
@@ -87,7 +87,7 @@ public final class LineNumberTable extends Attribute
implements Iterable<LineNum
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariable.java
b/src/main/java/org/apache/bcel/classfile/LocalVariable.java
index d483d4f7..d519d846 100644
--- a/src/main/java/org/apache/bcel/classfile/LocalVariable.java
+++ b/src/main/java/org/apache/bcel/classfile/LocalVariable.java
@@ -122,7 +122,7 @@ public final class LocalVariable implements Cloneable,
Node, Constants {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
index 2e1605ee..d7c44ea5 100644
--- a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
@@ -85,7 +85,7 @@ public class LocalVariableTable extends Attribute implements
Iterable<LocalVaria
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Method.java
b/src/main/java/org/apache/bcel/classfile/Method.java
index e3f1c31b..235a3204 100644
--- a/src/main/java/org/apache/bcel/classfile/Method.java
+++ b/src/main/java/org/apache/bcel/classfile/Method.java
@@ -114,7 +114,7 @@ public final class Method extends FieldOrMethod {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Module.java
b/src/main/java/org/apache/bcel/classfile/Module.java
index 4fafe757..7d841f71 100644
--- a/src/main/java/org/apache/bcel/classfile/Module.java
+++ b/src/main/java/org/apache/bcel/classfile/Module.java
@@ -108,7 +108,7 @@ public final class Module extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleExports.java
b/src/main/java/org/apache/bcel/classfile/ModuleExports.java
index 383207ca..197e7021 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleExports.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleExports.java
@@ -58,7 +58,7 @@ public final class ModuleExports implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java
b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java
index 0f391a50..6527c34c 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java
@@ -74,8 +74,8 @@ public final class ModuleMainClass extends Attribute {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e.,
- * the hierarchy of methods, fields, attributes, etc. spawns a tree of
objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is,
+ * the hierarchy of methods, fields, attributes, and other elements forms
a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
index 43808968..83bb6145 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
@@ -58,7 +58,7 @@ public final class ModuleOpens implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModulePackages.java
b/src/main/java/org/apache/bcel/classfile/ModulePackages.java
index 53e55d47..493d5e43 100644
--- a/src/main/java/org/apache/bcel/classfile/ModulePackages.java
+++ b/src/main/java/org/apache/bcel/classfile/ModulePackages.java
@@ -78,7 +78,7 @@ public final class ModulePackages extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleProvides.java
b/src/main/java/org/apache/bcel/classfile/ModuleProvides.java
index 51afc8d3..2d7f441e 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleProvides.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleProvides.java
@@ -60,7 +60,7 @@ public final class ModuleProvides implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
b/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
index 83845130..1c9fba85 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
@@ -52,7 +52,7 @@ public final class ModuleRequires implements Cloneable, Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/NestHost.java
b/src/main/java/org/apache/bcel/classfile/NestHost.java
index 61776bdf..699eb3bc 100644
--- a/src/main/java/org/apache/bcel/classfile/NestHost.java
+++ b/src/main/java/org/apache/bcel/classfile/NestHost.java
@@ -75,7 +75,7 @@ public final class NestHost extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/NestMembers.java
b/src/main/java/org/apache/bcel/classfile/NestMembers.java
index dbfb928e..ebb699de 100644
--- a/src/main/java/org/apache/bcel/classfile/NestMembers.java
+++ b/src/main/java/org/apache/bcel/classfile/NestMembers.java
@@ -79,7 +79,7 @@ public final class NestMembers extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/PMGClass.java
b/src/main/java/org/apache/bcel/classfile/PMGClass.java
index 70d27a5b..4e730f7f 100644
--- a/src/main/java/org/apache/bcel/classfile/PMGClass.java
+++ b/src/main/java/org/apache/bcel/classfile/PMGClass.java
@@ -75,7 +75,7 @@ public final class PMGClass extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git
a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
index df48f743..91e83073 100644
--- a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
@@ -80,7 +80,7 @@ public class ParameterAnnotationEntry implements Node {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
b/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
index 8d39af10..3f4078f7 100644
--- a/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
+++ b/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
@@ -75,7 +75,7 @@ public abstract class ParameterAnnotations extends Attribute
implements Iterable
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/PermittedSubclasses.java
b/src/main/java/org/apache/bcel/classfile/PermittedSubclasses.java
index dec87cbd..511aa580 100644
--- a/src/main/java/org/apache/bcel/classfile/PermittedSubclasses.java
+++ b/src/main/java/org/apache/bcel/classfile/PermittedSubclasses.java
@@ -80,7 +80,7 @@ public final class PermittedSubclasses extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Record.java
b/src/main/java/org/apache/bcel/classfile/Record.java
index de31aaab..327dee1b 100644
--- a/src/main/java/org/apache/bcel/classfile/Record.java
+++ b/src/main/java/org/apache/bcel/classfile/Record.java
@@ -83,7 +83,7 @@ public final class Record extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
* defined by the contents of a Java class. For example, the hierarchy of
methods,
- * fields, attributes, etc. spawns a tree of objects.
+ * fields, attributes, and other elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Signature.java
b/src/main/java/org/apache/bcel/classfile/Signature.java
index 4a43cccf..9f5bf398 100644
--- a/src/main/java/org/apache/bcel/classfile/Signature.java
+++ b/src/main/java/org/apache/bcel/classfile/Signature.java
@@ -227,7 +227,7 @@ public final class Signature extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/SourceFile.java
b/src/main/java/org/apache/bcel/classfile/SourceFile.java
index 09e914b6..095410f8 100644
--- a/src/main/java/org/apache/bcel/classfile/SourceFile.java
+++ b/src/main/java/org/apache/bcel/classfile/SourceFile.java
@@ -77,7 +77,7 @@ public final class SourceFile extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/StackMap.java
b/src/main/java/org/apache/bcel/classfile/StackMap.java
index 72a435ce..b11e242e 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMap.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMap.java
@@ -83,7 +83,7 @@ public final class StackMap extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
index 30808de2..e05a95b6 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
@@ -148,7 +148,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapType.java
b/src/main/java/org/apache/bcel/classfile/StackMapType.java
index 17f49e9e..3f31a4fb 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapType.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapType.java
@@ -72,7 +72,7 @@ public final class StackMapType implements Node, Cloneable {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
* @since 6.8.0
diff --git a/src/main/java/org/apache/bcel/classfile/Synthetic.java
b/src/main/java/org/apache/bcel/classfile/Synthetic.java
index 2968e0fe..1323b079 100644
--- a/src/main/java/org/apache/bcel/classfile/Synthetic.java
+++ b/src/main/java/org/apache/bcel/classfile/Synthetic.java
@@ -81,8 +81,8 @@ public final class Synthetic extends Attribute {
}
/**
- * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. I.e., the hierarchy of methods, fields,
- * attributes, etc. spawns a tree of objects.
+ * Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class. That is, the hierarchy of methods,
fields,
+ * attributes, and other elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/TypeAnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/TypeAnnotationEntry.java
index c076a964..5c7caf61 100644
--- a/src/main/java/org/apache/bcel/classfile/TypeAnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/TypeAnnotationEntry.java
@@ -120,7 +120,7 @@ public class TypeAnnotationEntry {
*
* @param targetType The target type.
* @return the size of the target info, or -1 if it depends on its content
(the table of a {@code localvar_target}).
- * @throws ClassFormatException if the target type is not defined.
+ * @throws ClassFormatException Thrown if the target type is not defined.
*/
private static int targetInfoSize(final int targetType) {
switch (targetType) {
@@ -212,8 +212,8 @@ public class TypeAnnotationEntry {
* @param targetInfo The target info, as it is stored in the class file.
* @param typePath The type path, as it is stored in the class file
without its length: a pair of bytes (path kind, type argument index) per step.
* @param annotationEntry The annotation.
- * @throws ClassFormatException if the target type is not defined.
- * @throws IllegalArgumentException if the target info does not have the
size its target type requires, or if the type path is not a sequence of pairs
+ * @throws ClassFormatException Thrown if the target type is not defined.
+ * @throws IllegalArgumentException Thrown if the target info does not
have the size its target type requires, or if the type path is not a sequence
of pairs
* of bytes of at most 255 steps.
*/
public TypeAnnotationEntry(final int targetType, final byte[] targetInfo,
final byte[] typePath, final AnnotationEntry annotationEntry) {
diff --git a/src/main/java/org/apache/bcel/classfile/Unknown.java
b/src/main/java/org/apache/bcel/classfile/Unknown.java
index f11f7e9c..b515db34 100644
--- a/src/main/java/org/apache/bcel/classfile/Unknown.java
+++ b/src/main/java/org/apache/bcel/classfile/Unknown.java
@@ -100,7 +100,7 @@ public final class Unknown extends Attribute {
/**
* Called by objects that are traversing the nodes of the tree implicitly
defined by the contents of a Java class.
- * I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree
of objects.
+ * That is, the hierarchy of methods, fields, attributes, and other
elements forms a tree of objects.
*
* @param v Visitor object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java
b/src/main/java/org/apache/bcel/classfile/Utility.java
index a01852d6..dcf9c280 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -652,7 +652,7 @@ public abstract class Utility {
}
/**
- * Escape all occurrences of newline chars '\n', quotes \", etc.
+ * Escape all occurrences of newline chars '\n', quotes \", and so on.
*
* @param label The string to convert.
* @return The converted string.
@@ -1230,7 +1230,7 @@ public abstract class Utility {
}
/**
- * Map opcode names to opcode numbers. E.g., return Constants.ALOAD for
"aload".
+ * Map opcode names to opcode numbers. For example, return Constants.ALOAD
for "aload".
*
* @param name The opcode name.
* @return The value.
diff --git a/src/main/java/org/apache/bcel/classfile/Visitor.java
b/src/main/java/org/apache/bcel/classfile/Visitor.java
index 2e644120..6c8608af 100644
--- a/src/main/java/org/apache/bcel/classfile/Visitor.java
+++ b/src/main/java/org/apache/bcel/classfile/Visitor.java
@@ -19,7 +19,7 @@
package org.apache.bcel.classfile;
/**
- * Interface to make use of the Visitor pattern programming style. I.e. a
class that implements this interface can
+ * Interface to make use of the Visitor pattern programming style. That is, a
class that implements this interface can
* traverse the contents of a Java class just by calling the 'accept' method
which all classes have.
*/
public interface Visitor {
diff --git a/src/main/java/org/apache/bcel/generic/CPInstruction.java
b/src/main/java/org/apache/bcel/generic/CPInstruction.java
index 1af509eb..c2377acd 100644
--- a/src/main/java/org/apache/bcel/generic/CPInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/CPInstruction.java
@@ -29,7 +29,7 @@ import org.apache.bcel.classfile.Utility;
import org.apache.bcel.util.ByteSequence;
/**
- * Abstract superclass for instructions that use an index into the constant
pool such as LDC, INVOKEVIRTUAL, etc.
+ * Abstract superclass for instructions that use an index into the constant
pool such as LDC, INVOKEVIRTUAL, and so on.
*
* @see ConstantPoolGen
* @see LDC
diff --git a/src/main/java/org/apache/bcel/generic/ClassGen.java
b/src/main/java/org/apache/bcel/generic/ClassGen.java
index 004687e4..b6801f07 100644
--- a/src/main/java/org/apache/bcel/generic/ClassGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassGen.java
@@ -88,7 +88,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
private int major = Const.MAJOR_1_1;
private int minor = Const.MINOR_1_1;
private ConstantPoolGen cp; // Template for building up constant pool
- // ArrayLists instead of arrays to gather fields, methods, etc.
+ // ArrayLists instead of arrays to gather fields, methods, and so on.
private final List<Field> fieldList = new ArrayList<>();
private final List<Method> methodList = new ArrayList<>();
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
index 7813aa5e..264990ad 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Denotes a push instruction that produces a literal on the stack such as
SIPUSH, BIPUSH, ICONST, etc.
+ * Denotes a push instruction that produces a literal on the stack such as
SIPUSH, BIPUSH, ICONST, and so on.
*
*
* @see ICONST
diff --git a/src/main/java/org/apache/bcel/generic/FieldGen.java
b/src/main/java/org/apache/bcel/generic/FieldGen.java
index ca8223fc..3a3f73e3 100644
--- a/src/main/java/org/apache/bcel/generic/FieldGen.java
+++ b/src/main/java/org/apache/bcel/generic/FieldGen.java
@@ -251,7 +251,9 @@ public class FieldGen extends FieldGenOrMethodGen {
/**
* Sets the initial value.
*
- * <p>Records an explicit constant value, including {@code false}. Use
{@link #cancelInitValue()} to remove it.</p>
+ * <p>
+ * Records an explicit constant value, including {@code false}. Use {@link
#cancelInitValue()} to remove it.
+ * </p>
*
* @param b The boolean value.
*/
diff --git a/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
b/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
index 4865e8f9..828b5165 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, for example local variable
instructions, RET, CPInstruction, etc.
+ * Denotes an entity that refers to an index, for example local variable
instructions, RET, CPInstruction, and so on.
*/
public interface IndexedInstruction {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionComparator.java
b/src/main/java/org/apache/bcel/generic/InstructionComparator.java
index f4739a6d..7f17ce52 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionComparator.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionComparator.java
@@ -19,10 +19,10 @@
package org.apache.bcel.generic;
/**
- * Equality of instructions isn't clearly to be defined. You might wish, for
example, to compare whether instructions
- * have the same meaning. E.g., whether two INVOKEVIRTUALs describe the same
call.
+ * Instruction equality can be defined in different ways. You might wish to
compare whether instructions have the same meaning,
+ * for example, whether two INVOKEVIRTUALs describe the same call.
* <p>
- * The DEFAULT comparator however, considers two instructions to be equal if
they have same opcode and point to the same
+ * The DEFAULT comparator, however, considers two instructions to be equal if
they have the same opcode and point to the same
* indexes (if any) in the constant pool or the same local variable index.
Branch instructions must have the same
* target.
* </p>
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConst.java
b/src/main/java/org/apache/bcel/generic/InstructionConst.java
index ea95574c..d267670d 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConst.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConst.java
@@ -24,12 +24,11 @@ import org.apache.bcel.Const;
/**
* Contains shareable instruction objects.
* <p>
- * In order to save memory you can use some instructions multiply, since they
have an immutable state and are directly derived from Instruction. I.e. they
have
- * no instance fields that could be changed. Since some of these instructions
like ICONST_0 occur very frequently this can save a lot of time and space. This
- * feature is an adaptation of the FlyWeight design pattern, we just use an
array instead of a factory.
+ * Reusing predefined instruction objects can save time and memory, especially
for frequently used instructions such as ICONST_0.
+ * These objects are shared and should not be modified. This approach adapts
the Flyweight design pattern by using an array instead of a factory.
* </p>
* <p>
- * The Instructions can also accessed directly under their names, so it's
possible to write il.append(Instruction.ICONST_0);
+ * The instruction objects can also be accessed directly by name, for example,
{@code il.append(InstructionConst.ICONST_0)}.
* </p>
*/
public final class InstructionConst {
@@ -402,7 +401,7 @@ public final class InstructionConst {
public static final LocalVariableInstruction ISTORE_2 = new ISTORE(2);
/**
- * Gets object via its opcode, for immutable instructions like branch
instructions entries are set to null.
+ * Instruction objects indexed by opcode. Entries for instructions without
a predefined instance, such as branch instructions, are null.
*/
static final Instruction[] INSTRUCTIONS = new Instruction[256];
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConstants.java
b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
index 11f5688e..dbc39e94 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConstants.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConstants.java
@@ -22,12 +22,11 @@ package org.apache.bcel.generic;
/**
* Contains shareable instruction objects.
* <p>
- * In order to save memory you can use some instructions multiply, since they
have an immutable state and are directly derived from Instruction. I.e. they
have
- * no instance fields that could be changed. Since some of these instructions
like ICONST_0 occur very frequently this can save a lot of time and space. This
- * feature is an adaptation of the FlyWeight design pattern, we just use an
array instead of a factory.
+ * Reusing predefined instruction objects can save time and memory, especially
for frequently used instructions such as ICONST_0.
+ * These objects are shared and should not be modified. This approach adapts
the Flyweight design pattern by using an array instead of a factory.
* </p>
* <p>
- * The Instructions can also accessed directly under their names, so it's
possible to write il.append(Instruction.ICONST_0);
+ * The instruction objects can also be accessed directly by name, for example,
{@code il.append(InstructionConst.ICONST_0)}.
* </p>
*
* @deprecated (since 6.0) Do not use. Use {@link InstructionConst} instead.
@@ -1016,7 +1015,7 @@ public interface InstructionConstants {
LocalVariableInstruction ISTORE_2 = InstructionConst.ISTORE_2;
/**
- * Gets object via its opcode, for immutable instructions like branch
instructions entries are set to null.
+ * Instruction objects indexed by opcode. Entries for instructions without
a predefined instance, such as branch instructions, are null.
*
* @deprecated Use {@link InstructionConst#INSTRUCTIONS}.
*/
diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
index df17a841..9c59d20a 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
@@ -241,7 +241,7 @@ public class InstructionFactory implements
InstructionConstants {
/**
* Create binary operation for simple basic types, such as int and float.
*
- * @param op operation, such as "+", "*", "<<", etc.
+ * @param op operation, such as "+", "*", "<<", and so on.
* @param type The operand type.
* @return The binary arithmetic instruction.
*/
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index c646beb2..dbdd69af 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -1165,7 +1165,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
pos[count++] = index;
/*
* Gets an estimate about how many additional bytes may be added,
because BranchInstructions may have variable length
- * depending on the target offset (short vs. int) or alignment
issues (TABLESWITCH and LOOKUPSWITCH).
+ * depending on the target offset (short or int) or alignment
issues (TABLESWITCH and LOOKUPSWITCH).
*/
switch (i.getOpcode()) {
case Const.JSR:
diff --git a/src/main/java/org/apache/bcel/generic/MethodGen.java
b/src/main/java/org/apache/bcel/generic/MethodGen.java
index f928f42b..c7bc6237 100644
--- a/src/main/java/org/apache/bcel/generic/MethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/MethodGen.java
@@ -1211,7 +1211,7 @@ public class MethodGen extends FieldGenOrMethodGen {
}
}
// Local variables may be registered (for example, copied from an
existing LocalVariableTable) without
- // being referenced by any instruction, e.g. unused variables
emitted by some compilers. Account for
+ // being referenced by any instruction, for example unused
variables emitted by some compilers. Account for
// those too, so a later call does not shrink maxLocals below what
those entries require.
for (final LocalVariableGen lv : variableList) {
final int index = lv.getIndex() + lv.getType().getSize();
diff --git a/src/main/java/org/apache/bcel/generic/PushInstruction.java
b/src/main/java/org/apache/bcel/generic/PushInstruction.java
index 281b2877..79e3fe54 100644
--- a/src/main/java/org/apache/bcel/generic/PushInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/PushInstruction.java
@@ -20,7 +20,7 @@ package org.apache.bcel.generic;
/**
* Denotes an unparameterized instruction to produce a value on top of the
stack, such as ILOAD, LDC, SIPUSH, DUP,
- * ICONST, etc.
+ * ICONST, and so on.
*
*
* @see ILOAD
diff --git a/src/main/java/org/apache/bcel/generic/SWITCH.java
b/src/main/java/org/apache/bcel/generic/SWITCH.java
index 3c5ed4fc..40aebeb6 100644
--- a/src/main/java/org/apache/bcel/generic/SWITCH.java
+++ b/src/main/java/org/apache/bcel/generic/SWITCH.java
@@ -91,12 +91,12 @@ public final class SWITCH implements CompoundInstruction {
* maxGap between the numbers, a TABLESWITCH instruction is generated, and
a LOOKUPSWITCH otherwise. The former may be
* more efficient, but needs more space.
*
- * Note, that the key array always will be sorted, though we leave the
original arrays unaltered.
+ * Note that the key array will always be sorted, though we leave the
original arrays unaltered.
*
- * @param match array of match values (case 2: ... case 7: ..., etc.).
+ * @param match array of match values (case 2: ... case 7: ..., and so on).
* @param targets The instructions to be branched to for each case.
* @param target The default target.
- * @param maxGap maximum gap that may between case branches.
+ * @param maxGap maximum gap allowed between case branches.
*/
public SWITCH(final int[] match, final InstructionHandle[] targets, final
InstructionHandle target, final int maxGap) {
final int[] matchClone = match.clone();
diff --git a/src/main/java/org/apache/bcel/generic/Select.java
b/src/main/java/org/apache/bcel/generic/Select.java
index af7ee800..0a20baa4 100644
--- a/src/main/java/org/apache/bcel/generic/Select.java
+++ b/src/main/java/org/apache/bcel/generic/Select.java
@@ -372,7 +372,7 @@ public abstract class Select extends BranchInstruction
implements VariableLength
*/
@Override
protected int updatePosition(final int offset, final int maxOffset) {
- setPosition(getPosition() + offset); // Additional offset caused by
preceding switch instructions, GOTO instructions, etc.
+ setPosition(getPosition() + offset); // Additional offset caused by
preceding switch instructions, GOTO instructions, and so on.
final short oldLength = (short) super.getLength();
/*
* Alignment on 4-byte-boundary, + 1, because of tag byte.
diff --git a/src/main/java/org/apache/bcel/generic/TargetLostException.java
b/src/main/java/org/apache/bcel/generic/TargetLostException.java
index a543e6a0..d7db475e 100644
--- a/src/main/java/org/apache/bcel/generic/TargetLostException.java
+++ b/src/main/java/org/apache/bcel/generic/TargetLostException.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Thrown by {@link InstructionList} when one or multiple disposed
instructions are still being referenced by an {@link InstructionTargeter}
object. I.e. the
+ * Thrown by {@link InstructionList} when one or multiple disposed
instructions are still being referenced by an {@link InstructionTargeter}
object. That is, the
* {@link InstructionTargeter} has to be notified that (one of) the {@link
InstructionHandle} it is referencing is being removed from the
* {@link InstructionList} and thus not valid anymore.
*
diff --git a/src/main/java/org/apache/bcel/generic/Visitor.java
b/src/main/java/org/apache/bcel/generic/Visitor.java
index cb2643da..55c51228 100644
--- a/src/main/java/org/apache/bcel/generic/Visitor.java
+++ b/src/main/java/org/apache/bcel/generic/Visitor.java
@@ -19,7 +19,7 @@
package org.apache.bcel.generic;
/**
- * Interface implementing the Visitor pattern programming style. I.e., a class
that implements this interface can handle
+ * Interface implementing the Visitor pattern programming style. That is, a
class that implements this interface can handle
* all types of instructions with the properly typed methods just by calling
the accept() method.
*/
public interface Visitor {
diff --git
a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
index 787b1a9d..eecd5829 100644
--- a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
@@ -26,7 +26,7 @@ import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Utility;
/**
- * This abstract class provides a logic of a loading {@link JavaClass} objects
class names via {@link ClassPath}.
+ * This abstract class provides logic for loading {@link JavaClass} objects by
class name through {@link ClassPath}.
*
* <p>
* Subclasses can choose caching strategy of the objects by implementing the
abstract methods (for example,
diff --git a/src/main/java/org/apache/bcel/util/ClassPath.java
b/src/main/java/org/apache/bcel/util/ClassPath.java
index ee73b479..4e5a45bb 100644
--- a/src/main/java/org/apache/bcel/util/ClassPath.java
+++ b/src/main/java/org/apache/bcel/util/ClassPath.java
@@ -472,8 +472,11 @@ public class ClassPath implements Closeable {
}
/**
- * Checks for class path components in the following properties:
"java.class.path", "sun.boot.class.path",
- * "java.ext.dirs"
+ * Gets the default class path used by BCEL.
+ *
+ * <p>
+ * Collects class path components from "java.class.path",
"sun.boot.class.path", and "java.ext.dirs", along with runtime modules under
"java.home".
+ * </p>
*
* @return class path as used by default by BCEL.
*/
diff --git a/src/main/java/org/apache/bcel/util/CodeHTML.java
b/src/main/java/org/apache/bcel/util/CodeHTML.java
index e6447b4d..097592ed 100644
--- a/src/main/java/org/apache/bcel/util/CodeHTML.java
+++ b/src/main/java/org/apache/bcel/util/CodeHTML.java
@@ -409,7 +409,7 @@ final class CodeHTML {
}
}
}
- // Get target addresses from GOTO, JSR, TABLESWITCH, etc.
+ // Get target addresses from GOTO, JSR, TABLESWITCH, and so on.
while (bytes.available() > 0) {
opcode = bytes.readUnsignedByte();
// System.out.println(getOpcodeName(opcode));
@@ -551,7 +551,7 @@ final class CodeHTML {
final String str = codeToHTML(stream, methodNumber);
String anchor = "";
/*
- * Sets an anchor mark if this line is targeted by a goto,
jsr, etc. Defining an anchor for every line is very
+ * Sets an anchor mark if this line is targeted by a goto,
jsr, and so on. Defining an anchor for every line is very
* inefficient!
*/
if (gotoSet.get(offset)) {
diff --git a/src/main/java/org/apache/bcel/util/ConstantHTML.java
b/src/main/java/org/apache/bcel/util/ConstantHTML.java
index 7f3da35e..953ee1f9 100644
--- a/src/main/java/org/apache/bcel/util/ConstantHTML.java
+++ b/src/main/java/org/apache/bcel/util/ConstantHTML.java
@@ -121,7 +121,7 @@ final class ConstantHTML {
final String htmlMethodName = Class2HTML.toHTML(methodName);
// Partially compacted class name, that is, / -> .
final String methodClass =
constantPool.constantToString(classIndex, Const.CONSTANT_Class);
- String shortMethodClass = Utility.compactClassName(methodClass);
// I.e., remove java.lang.
+ String shortMethodClass = Utility.compactClassName(methodClass);
// That is, remove java.lang.
shortMethodClass = Utility.compactClassName(shortMethodClass,
classPackage + ".", true); // Remove class package prefix
shortMethodClass = Class2HTML.toHTML(shortMethodClass);
// Get method signature
@@ -158,7 +158,7 @@ final class ConstantHTML {
nameIndex = c3.getNameAndTypeIndex();
// Get method name and its class (compacted)
final String fieldClass =
constantPool.constantToString(classIndex, Const.CONSTANT_Class);
- String shortFieldClass = Utility.compactClassName(fieldClass); //
I.e., remove java.lang.
+ String shortFieldClass = Utility.compactClassName(fieldClass); //
That is, remove java.lang.
shortFieldClass = Utility.compactClassName(shortFieldClass,
classPackage + ".", true); // Remove class package prefix
shortFieldClass = Class2HTML.toHTML(shortFieldClass);
final String fieldName = constantPool.constantToString(nameIndex,
Const.CONSTANT_NameAndType);
@@ -177,7 +177,7 @@ final class ConstantHTML {
final ConstantClass c4 = constantPool.getConstant(index,
Const.CONSTANT_Class, ConstantClass.class);
nameIndex = c4.getNameIndex();
final String className2 = constantPool.constantToString(index,
tag); // / -> .
- String shortClassName = Utility.compactClassName(className2); //
I.e., remove java.lang.
+ String shortClassName = Utility.compactClassName(className2); //
That is, remove java.lang.
shortClassName = Utility.compactClassName(shortClassName,
classPackage + ".", true); // Remove class package prefix
shortClassName = Class2HTML.toHTML(shortClassName);
ref = "<A HREF=\"" + Class2HTML.toHTMLRef(className2) + ".html\"
TARGET=_top>" + shortClassName + "</A>";
diff --git a/src/main/java/org/apache/bcel/util/InstructionFinder.java
b/src/main/java/org/apache/bcel/util/InstructionFinder.java
index d80e477f..a2bf886d 100644
--- a/src/main/java/org/apache/bcel/util/InstructionFinder.java
+++ b/src/main/java/org/apache/bcel/util/InstructionFinder.java
@@ -64,7 +64,7 @@ public class InstructionFinder {
/**
* Code patterns found may be checked using an additional user-defined
constraint object whether they really match the
- * needed criterion. I.e., check constraints that cannot expressed with
regular expressions.
+ * needed criterion. That is, check constraints that cannot be expressed
with regular expressions.
*/
public interface CodeConstraint {
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 a3abb0e2..bb6a941a 100644
---
a/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
+++
b/src/main/java/org/apache/bcel/verifier/structurals/InstConstraintVisitor.java
@@ -2459,8 +2459,8 @@ public class InstConstraintVisitor extends EmptyVisitor {
/**
* Ensures the general preconditions of an instruction that accesses the
stack. This method is here because BCEL has no
- * such superinterface for the stack accessing instructions; and there are
funny unexpected exceptions in the semantices
- * of the superinterfaces and superclasses provided. E.g. SWAP is a
StackConsumer, but DUP_X1 is not a StackProducer.
+ * such superinterface for the stack accessing instructions; and there are
funny unexpected exceptions in the semantics
+ * of the superinterfaces and superclasses provided. For example, SWAP is
a StackConsumer, but DUP_X1 is not a StackProducer.
* Therefore, this method is called by all StackProducer, StackConsumer,
and StackInstruction instances via their
* visitXXX() method. Unfortunately, as the superclasses and
superinterfaces overlap, some instructions cause this
* method to be called two or three times. [TODO: Fix this.]
diff --git a/src/site/markdown/security.md b/src/site/markdown/security.md
index d63a5984..9e779b52 100644
--- a/src/site/markdown/security.md
+++ b/src/site/markdown/security.md
@@ -33,7 +33,7 @@ If you have encountered an unlisted security vulnerability or
other unexpected b
## Security Model
-The [Apache Commons security
model](https://commons.apache.org/security.html#Security_Model) specifies that
it is unsafe to pass possibly malicious input to Commons libraries unless
otherwise specified. For Commons BCEL, processing untrusted class data is
supported to the extent that this should never allow the supplier of the data
to trigger arbitrary code execution, filesystem or network access. It may still
trigger other crashes, such as for example `StackOverflowError` or `OutOfMemor
[...]
+The [Apache Commons security
model](https://commons.apache.org/security.html#Security_Model) specifies that
it is unsafe to pass possibly malicious input to Commons libraries unless
otherwise specified. For Commons BCEL, processing untrusted class data is
supported to the extent that this should never allow the supplier of the data
to trigger arbitrary code execution, filesystem or network access. It may still
trigger other crashes, such as `StackOverflowError` or `OutOfMemoryError`: if
[...]
## Security Vulnerabilities Fixed in 6.13.0
diff --git a/src/site/xdoc/faq.xml b/src/site/xdoc/faq.xml
index 8069f404..52bb2392 100644
--- a/src/site/xdoc/faq.xml
+++ b/src/site/xdoc/faq.xml
@@ -51,7 +51,7 @@
<br/>
<b>A: </b> Yes, this is covered by the <a
href="https://www.apache.org/licenses/";>Apache License</a>, if you add a
note about the original
- author and where to find the sources, i.e.,
+ author and where to find the sources, that is,
<a
href="https://commons.apache.org/bcel/";>https://commons.apache.org/bcel/</a>
</p>
@@ -64,10 +64,10 @@
</p>
<p>
<b>A: </b> The answer lies in internal limitations of the JVM,
- branch instruction like goto can not address offsets larger than
- a short integer, i.e. offsets >= 32767.<br/>
- The solution is to split the branch into in intermediate hops,
- which the XSLTC obviously doesn't take care off.
+ branch instructions like goto cannot address offsets larger than
+ a short integer, that is, offsets >= 32767.<br/>
+ The solution is to split the branch into intermediate hops,
+ which XSLTC does not handle.
(In fact you could replace gotos with the goto_w instruction,
but this wouldn't help in the other cases).
</p>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index e6469e32..b03103ec 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -36,7 +36,7 @@
</p>
<p>
Such objects can be read from an existing file, be transformed
- by a program (e.g. a class loader at run-time) and written to a file
again.
+ by a program (for example a class loader at run-time) and written to a
file again.
An even more interesting application is the creation of classes from
scratch
at run-time. The Byte Code Engineering Library (BCEL) may be also
useful
if you want to learn about the Java Virtual Machine (JVM) and the
format of
@@ -66,7 +66,9 @@
</p>
</section>
<section name="Release Information">
- <p>The latest stable release of BCEL is here, you may: </p>
+ <p>
+ For the latest stable release of BCEL, you can:
+ </p>
<ul>
<li><a
href="https://commons.apache.org/proper/commons-bcel/download_bcel.cgi";>Download</a></li>
<li>Read the <a
href="https://www.apache.org/dist/commons/bcel/RELEASE-NOTES.txt";>release
notes</a></li>
@@ -79,10 +81,17 @@
</section>
<section name="Getting Involved">
<p>
- The <a href="mail-lists.html">commons developer mailing list</a> is
the main channel of communication for contributors. Please remember that the
lists are shared between all commons components, so prefix your email by
[bcel]. </p>
- <p>You can also peruse <a href="issue-tracking.html">JIRA</a>.</p>
- <p>Alternatively you can go through the <em>Needs Work</em> tags in the
<a href="taglist.html">TagList report</a>.</p>
- <p>If you'd like to offer up pull requests via GitHub rather than
applying patches to JIRA, we have a <a
href="https://github.com/apache/commons-bcel/";>GitHub mirror</a>. </p>
+ The <a href="mail-lists.html">commons developer mailing list</a> is
the main channel of communication for contributors. Please remember that the
lists are shared between all commons components, so prefix your email subject
with [bcel].
+ </p>
+ <p>
+ You can also peruse <a href="issue-tracking.html">JIRA</a>.
+ </p>
+ <p>
+ Alternatively, you can go through the <em>Needs Work</em> tags in the
<a href="taglist.html">TagList report</a>.
+ </p>
+ <p>
+ If you'd like to offer up pull requests via GitHub rather than
applying patches to JIRA, we have a <a
href="https://github.com/apache/commons-bcel/";>GitHub mirror</a>.
+ </p>
</section>
</body>
</document>
diff --git a/src/site/xdoc/manual/appendix.xml
b/src/site/xdoc/manual/appendix.xml
index 192b1f0e..9be39b29 100644
--- a/src/site/xdoc/manual/appendix.xml
+++ b/src/site/xdoc/manual/appendix.xml
@@ -71,7 +71,8 @@ public class HelloWorld {
<source>Type.getMethodSignature(Type.STRINGBUFFER, new Type[] {
Type.STRING });</source>
- <p><b>Initialization:</b>
+ <p>
+ <b>Initialization:</b>
First we create an empty class and an instruction list:
</p>
@@ -107,8 +108,9 @@ ObjectType i_stream = new ObjectType("java.io.InputStream");
ObjectType p_stream = new ObjectType("java.io.PrintStream");
</source>
- <p><b>Create variables <tt>in</tt> and <tt>name</tt>:</b> We call
- the constructors, i.e., execute
+ <p>
+ <b>Create variables <tt>in</tt> and <tt>name</tt>:</b> We call
+ the constructors, that is, execute
<tt>BufferedReader(InputStreamReader(System.in))</tt>. The reference
to the <tt>BufferedReader</tt> object stays on top of the stack and
is stored in the newly allocated <tt>in</tt> variable.
@@ -144,7 +146,8 @@ il.append(InstructionConstants.ACONST_NULL);
lg.setStart(il.append(new ASTORE(name))); // "name" valid from here
</source>
- <p><b>Create try-catch block:</b> We remember the start of the
+ <p>
+ <b>Create try-catch block:</b> We remember the start of the
block, read a line from the standard input and store it into the
variable <tt>name</tt>.
</p>
@@ -193,8 +196,9 @@ InstructionHandle ih =
g.setTarget(ih);
</source>
- <p><b>Printing "Hello":</b>
-String concatenation compiles to <tt>StringBuffer</tt> operations.
+ <p>
+ <b>Printing "Hello":</b>
+ String concatenation compiles to <tt>StringBuffer</tt> operations.
</p>
<source>
@@ -219,7 +223,8 @@ il.append(InstructionConstants.RETURN);
</source>
- <p><b>Finalization:</b> Finally, we have to set the stack size,
+ <p>
+ <b>Finalization:</b> Finally, we have to set the stack size,
which normally would have to be computed on the fly and add a
default constructor method to the class, which is empty in this
case.
@@ -364,28 +369,28 @@ public class Peephole {
java org.apache.bcel.verifier.Verifier fully.qualified.class.Name
</source>
<p>
- lets JustIce work standalone.
- If you get a "java.lang.OutOfMemoryError", you should increase the
- maximum Java heap space. A command like
+ lets JustIce work standalone.
+ If you get a "java.lang.OutOfMemoryError", you should increase the
+ maximum Java heap space. A command like
</p>
<source>
java -Xmx1887436800 org.apache.bcel.verifier.Verifier f.q.c.Name
</source>
<p>
- will usually resolve the problem. The value above is suitable for
- big server machines; if your machine starts swapping to disk, try
- to lower the value.
+ will usually resolve the problem. The value above is suitable for
+ big server machines; if your machine starts swapping to disk, try
+ to lower the value.
</p>
<h4>Running a graphics based verifier</h4>
<p>
- If you prefer a graphical application, you should use a command like
+ If you prefer a graphical application, you should use a command like
</p>
<source>
java org.apache.bcel.verifier.GraphicalVerifier
</source>
<p>
- to launch one. Again, you may have to resolve a memory issue depending
- on the classes to verify.
+ to launch one. Again, you may have to resolve a memory issue depending
+ on the classes to verify.
</p>
</subsection>
</section>
diff --git a/src/site/xdoc/manual/application-areas.xml
b/src/site/xdoc/manual/application-areas.xml
index d153ef24..4bc72f33 100644
--- a/src/site/xdoc/manual/application-areas.xml
+++ b/src/site/xdoc/manual/application-areas.xml
@@ -52,9 +52,8 @@
Class loaders are responsible for loading class files from the
file system or other resources and passing the byte code to the
Virtual Machine. A custom <tt>ClassLoader</tt> object may be used
- to intercept the standard procedure of loading a class, i.e.m the
- system class loader, and perform some transformations before
- actually passing the byte code to the JVM.
+ to intercept the standard class-loading procedure and transform
+ the byte code before passing it to the JVM.
</p>
<p>
@@ -108,14 +107,14 @@
performs some transformations on the loaded class and passes them
to the VM. The following algorithm illustrates how the load method
of the class loader fulfills the request for a parameterized
- class, e.g., <tt>Stack<String></tt>
+ class, for example, <tt>Stack<String></tt>.
</p>
<ol type="1">
<li> Search for class <tt>Stack</tt>, load it, and check for a
certain class attribute containing additional type
- information. I.e. the attribute defines the "real" name of the
- class, i.e., <tt>Stack<A></tt>.</li>
+ information. That is, the attribute defines the "real" name of the
+ class, that is, <tt>Stack<A></tt>.</li>
<li>Replace all occurrences and references to the formal type
<tt>A</tt> with references to the actual type <tt>String</tt>. For
diff --git a/src/site/xdoc/manual/bcel-api.xml
b/src/site/xdoc/manual/bcel-api.xml
index 013a583d..b7d04f58 100644
--- a/src/site/xdoc/manual/bcel-api.xml
+++ b/src/site/xdoc/manual/bcel-api.xml
@@ -36,12 +36,12 @@
<ol type="1">
<li> A package that contains classes that describe "static"
- constraints of class files, i.e., reflects the class file format
and
+ constraints of class files, that is, a package that reflects the
class file format and
is not intended for byte code modifications. The classes may be
used to read and write class files from or to a file. This is
useful especially for analyzing Java classes without having the
source files at hand. The main data structure is called
- <tt>JavaClass</tt> which contains methods, fields, etc..</li>
+ <tt>JavaClass</tt> which contains methods, fields, and so on.</li>
<li> A package to dynamically generate or modify
<tt>JavaClass</tt> or <tt>Method</tt> objects. It may be used to
@@ -100,8 +100,8 @@
<p>
Methods and fields contain a signature, symbolically defining
their types. Access flags like <tt>public static final</tt> occur
- in several places and are encoded by an integer bit mask, e.g.,
- <tt>public static final</tt> matches to the Java expression
+ in several places and are encoded by an integer bit mask. For example,
+ <tt>public static final</tt> corresponds to the Java expression
</p>
@@ -117,7 +117,7 @@
table of handled exceptions, and some optional debugging
information coded as <tt>LineNumberTable</tt> and
<tt>LocalVariableTable</tt> attributes. Attributes are in general
- specific to some data structure, i.e., no two components share the
+ specific to some data structure, that is, no two components share the
same kind of attribute, though this is not explicitly
forbidden. In the figure the <tt>Attribute</tt> classes are stereotyped
with the component they belong to.
@@ -232,7 +232,7 @@ Type[] arg_types = new Type[] { new ArrayType(Type.STRING,
1) };
<p>
Fields are represented by <tt>FieldGen</tt> objects, which may be
freely modified by the user. If they have the access rights
- <tt>static final</tt>, i.e., are constants and of basic type, they
+ <tt>static final</tt>, that is, are constants and of basic type, they
may optionally have an initializing value.
</p>
@@ -267,7 +267,7 @@ Type[] arg_types = new Type[] { new ArrayType(Type.STRING,
1) };
offsets. Instructions consist of an opcode (sometimes called
tag), their length in bytes and an offset (or index) within the
byte code. Since many instructions are immutable (stack operators,
- e.g.), the <tt>InstructionConstants</tt> interface offers
+ for example), the <tt>InstructionConstants</tt> interface offers
shareable predefined "fly-weight" constants to use.
</p>
@@ -275,24 +275,23 @@ Type[] arg_types = new Type[] { new
ArrayType(Type.STRING, 1) };
Instructions are grouped via sub-classing, the type hierarchy of
instruction classes is illustrated by (incomplete) figure in the
appendix. The most important family of instructions are the
- <em>branch instructions</em>, e.g., <tt>goto</tt>, that branch to
+ <em>branch instructions</em>, for example, <tt>goto</tt>, that branch
to
targets somewhere within the byte code. Obviously, this makes them
candidates for playing an <tt>InstructionTargeter</tt> role,
too. Instructions are further grouped by the interfaces they
- implement, there are, e.g., <tt>TypedInstruction</tt>s that are
+ implement. There are, for example, <tt>TypedInstruction</tt>s that are
associated with a specific type like <tt>ldc</tt>, or
<tt>ExceptionThrower</tt> instructions that may raise exceptions
when executed.
</p>
<p>
- All instructions can be traversed via <tt>accept(Visitor v)</tt>
- methods, i.e., the Visitor design pattern. There is however some
- special trick in these methods that allows to merge the handling
- of certain instruction groups. The <tt>accept()</tt> do not only
- call the corresponding <tt>visit()</tt> method, but call
- <tt>visit()</tt> methods of their respective super classes and
- implemented interfaces first, i.e., the most specific
+ All instructions can be traversed using <tt>accept(Visitor v)</tt>
+ methods, which implement the Visitor design pattern. These methods
+ allow the handling of certain instruction groups to be combined.
+ Before calling the corresponding <tt>visit()</tt> method, each
+ <tt>accept()</tt> method calls the <tt>visit()</tt> methods for the
+ respective superclasses and implemented interfaces. The most specific
<tt>visit()</tt> call is last. Thus one can group the handling of,
say, all <tt>BranchInstruction</tt>s into one single method.
</p>
@@ -326,7 +325,7 @@ Type[] arg_types = new Type[] { new ArrayType(Type.STRING,
1) };
areas of code very simple and also allows us to reuse immutable
instruction objects (fly-weight objects). Since we use symbolic
references, computation of concrete byte code offsets does not
- need to occur until finalization, i.e., until the user has
+ need to occur until finalization, that is, until the user has
finished the process of generating or transforming code. We will
use the term instruction handle and instruction synonymously
throughout the rest of the paper. Instruction handles may contain
@@ -339,7 +338,7 @@ Type[] arg_types = new Type[] { new ArrayType(Type.STRING,
1) };
lists anywhere to an existing list. The instructions are appended
after the given instruction handle. All append methods return a
new instruction handle which may then be used as the target of a
- branch instruction, e.g.:
+ branch instruction, for example:
</p>
<source>
@@ -494,8 +493,8 @@ il.append(f.createReturn(type));
simplify handling such situations BCEL introduces a special feature:
One can search for given code patterns within an instruction list
using <em>regular expressions</em>. In such expressions,
- instructions are represented by their opcode names, e.g.,
- <tt>LDC</tt>, one may also use their respective super classes, e.g.,
+ instructions are represented by their opcode names, for example,
+ <tt>LDC</tt>. One may also use their respective super classes, for
example,
"<tt>IfInstruction</tt>". Meta characters like <tt>+</tt>,
<tt>*</tt>, and <tt>(..|..)</tt> have their usual meanings. Thus,
the expression
@@ -533,7 +532,7 @@ il.append(f.createReturn(type));
<p>
When the code has been finalized these chunks can be optimized
with a <em>peep hole</em> algorithm: An <tt>IfInstruction</tt>
- (e.g. the comparison of two integers: <tt>if_icmpeq</tt>) that
+ (for example, the comparison of two integers: <tt>if_icmpeq</tt>) that
either produces a 1 or a 0 on the stack and is followed by an
<tt>ifne</tt> instruction (branch if stack value 0) may be
replaced by the <tt>IfInstruction</tt> with its branch target
diff --git a/src/site/xdoc/manual/jvm.xml b/src/site/xdoc/manual/jvm.xml
index 529c131a..6083b06f 100644
--- a/src/site/xdoc/manual/jvm.xml
+++ b/src/site/xdoc/manual/jvm.xml
@@ -82,8 +82,8 @@
instruction set are described in more detail in the <a
href="https://docs.oracle.com/javase/specs/";>Java
Virtual Machine Specification</a>. Especially, we will not deal
- with the security constraints that the Java Virtual Machine has to
- check at run-time, i.e. the byte code verifier.
+ with the security constraints that the byte code verifier checks
+ at run-time.
</p>
<p>
@@ -95,12 +95,12 @@
rights</em> of the class encoded by a bit mask, a list of
interfaces implemented by the class, lists containing the fields
and methods of the class, and finally the <em>class
- attributes</em>, e.g., the <tt>SourceFile</tt> attribute telling
+ attributes</em>, for example, the <tt>SourceFile</tt> attribute telling
the name of the source file. Attributes are a way of putting
additional, user-defined information into class file data
structures. For example, a custom class loader may evaluate such
attribute data in order to perform its transformations. The JVM
- specification declares that unknown, i.e., user-defined attributes
+ specification declares that unknown, that is, user-defined attributes
must be ignored by any Virtual Machine implementation.
</p>
@@ -155,11 +155,11 @@
<p>
For example, the <tt>invokevirtual</tt> instruction refers to a
<tt>MethodRef</tt> constant that contains information about the
- name of the called method, the signature (i.e., the encoded
+ name of the called method, the signature (that is, the encoded
argument and return types), and to which class the method belongs.
In fact, as emphasized by the boxed value, the <tt>MethodRef</tt>
constant itself just refers to other entries holding the real
- data, e.g., it refers to a <tt>ConstantClass</tt> entry containing
+ data. For example, it refers to a <tt>ConstantClass</tt> entry
containing
a symbolic reference to the class <tt>java.io.PrintStream</tt>.
To keep the class file compact, such constants are typically
shared by different instructions and other constant pool
@@ -183,9 +183,9 @@
local stack has to be computed by the compiler. Values may also be
stored intermediately in a frame area containing <em>local
variables</em> which can be used like a set of registers. These
- local variables are numbered from 0 to 65535, i.e., you have a
- maximum of 65536 of local variables per method. The stack frames
- of caller and callee method are overlapping, i.e., the caller
+ local variables are numbered from 0 to 65535, giving a
+ maximum of 65536 local variables per method. The stack frames
+ of the caller and callee overlap: the caller
pushes arguments onto the operand stack and the called method
receives them in local variables.
</p>
@@ -203,7 +203,7 @@
either by loading them from the constant pool with the
<tt>ldc</tt> instruction or with special "short-cut"
instructions where the operand is encoded into the instructions,
- e.g., <tt>iconst_0</tt> or <tt>bipush</tt> (push byte value).
+ for example, <tt>iconst_0</tt> or <tt>bipush</tt> (push byte value).
</p>
<p>
@@ -211,7 +211,7 @@
Virtual Machine distinguishes its operand types using different
instructions to operate on values of specific type. Arithmetic
operations starting with <tt>i</tt>, for example, denote an
- integer operation. E.g., <tt>iadd</tt> that adds two integers
+ integer operation. For example, <tt>iadd</tt> adds two integers
and pushes the result back on the stack. The Java types
<tt>boolean</tt>, <tt>byte</tt>, <tt>short</tt>, and
<tt>char</tt> are handled as integers by the JVM.
@@ -225,7 +225,7 @@
the <tt>finally</tt> clause of <tt>try-catch</tt> blocks.
Exceptions may be thrown with the <tt>athrow</tt> instruction.
Branch targets are coded as offsets from the current byte code
- position, i.e., with an integer number.
+ position, that is, with an integer number.
</p>
<p>
@@ -301,7 +301,7 @@
<p>
Whenever an exception is raised during execution, the JVM performs
exception handling by looking into a table of exception
- handlers. The table marks handlers, i.e., code chunks, to be
+ handlers. The table marks handlers, that is, code chunks, to be
responsible for exceptions of certain types that are raised within
a given area of the byte code. When there is no appropriate
handler the exception is propagated back to the caller of the
@@ -318,7 +318,7 @@
and local variables refer to absolute addresses within the byte
code. The former contains references to the start and the end of
the <tt>try</tt> block, and to the instruction handler code. The
- latter marks the range in which a local variable is valid, i.e.,
+ latter marks the range in which a local variable is valid, that is,
its scope. This makes it difficult to insert or delete code areas
on this level of abstraction, since one has to recompute the
offsets every time and update the referring objects. We will see
@@ -352,7 +352,7 @@
Classes are internally represented by strings like
<tt>"java/lang/String"</tt>, basic types like <tt>float</tt> by an
integer number. Within signatures they are represented by single
- characters, e.g., <tt>I</tt>, for integer. Arrays are denoted with
+ characters, for example, <tt>I</tt>, for integer. Arrays are denoted
with
a <tt>[</tt> at the start of the signature.
</p>
@@ -419,7 +419,8 @@ public class Factorial {
LocalVariable(start_pc = 0, length = 16, index = 0:int n)
</source>
- <p><b>fac():</b>
+ <p>
+ <b>fac():</b>
The method <tt>fac</tt> has only one local variable, the argument
<tt>n</tt>, stored at index 0. This variable's scope ranges from
the start of the byte code sequence to the very end. If the value
@@ -469,7 +470,8 @@ public class Factorial {
4 22 36 NumberFormatException(10)
</source>
- <p><b>readInt():</b> First the local variable <tt>n</tt> (at index 0)
+ <p>
+ <b>readInt():</b> First the local variable <tt>n</tt> (at index 0)
is initialized to the value 4711. The next instruction,
<tt>getstatic</tt>, loads the references held by the static
<tt>System.out</tt> field onto the stack. Then a string is loaded
@@ -494,7 +496,7 @@ public class Factorial {
<p>
The handler for <tt>java.io.IOException</tt> starts at
offset 25. It simply prints the error and branches back to the
- normal execution flow, i.e., as if no exception had occurred.
+ normal execution flow, that is, as if no exception had occurred.
</p>
</subsection>
diff --git
a/src/test/java/org/apache/bcel/classfile/TypeAnnotationEntryTest.java
b/src/test/java/org/apache/bcel/classfile/TypeAnnotationEntryTest.java
index b729beae..a938e597 100644
--- a/src/test/java/org/apache/bcel/classfile/TypeAnnotationEntryTest.java
+++ b/src/test/java/org/apache/bcel/classfile/TypeAnnotationEntryTest.java
@@ -279,6 +279,12 @@ class TypeAnnotationEntryTest {
void wrapsCopyIoFailures() {
final IOException failure = new IOException("Cannot encode the entry");
final TypeAnnotationEntry entry = new TypeAnnotationEntry(0x13, new
byte[0], new byte[0], null) {
+ /**
+ * Always throws the configured {@link IOException} to simulate an
encoding failure.
+ *
+ * @param out The unused output stream.
+ * @throws IOException Thrown unconditionally to simulate an
encoding failure.
+ */
@Override
public void dump(final DataOutputStream out) throws IOException {
throw failure;
diff --git a/src/test/java/org/apache/bcel/data/ConstantPoolX.java
b/src/test/java/org/apache/bcel/data/ConstantPoolX.java
index 8bda1483..40e99973 100644
--- a/src/test/java/org/apache/bcel/data/ConstantPoolX.java
+++ b/src/test/java/org/apache/bcel/data/ConstantPoolX.java
@@ -238,7 +238,7 @@ public abstract class ConstantPoolX implements Cloneable,
Node {
}
/**
- * Gets string from constant pool and bypass the indirection of
'ConstantClass' and 'ConstantString' objects. I.e. these
+ * Gets a string from the constant pool and bypasses the indirection of
'ConstantClass' and 'ConstantString' objects. That is, these
* classes have an index field that points to another entry of the
constant pool of type 'ConstantUtf8' which contains
* the real data.
*
diff --git a/src/test/java/org/apache/bcel/generic/MethodGenTest.java
b/src/test/java/org/apache/bcel/generic/MethodGenTest.java
index b8cb5ee7..69f647a6 100644
--- a/src/test/java/org/apache/bcel/generic/MethodGenTest.java
+++ b/src/test/java/org/apache/bcel/generic/MethodGenTest.java
@@ -147,7 +147,7 @@ class MethodGenTest {
@Test
void testSetMaxLocalsAccountsForLocalVariableTable() {
- // BCEL-280: some compilers (e.g. kotlinc) emit LocalVariableTable
entries for slots that no
+ // BCEL-280: some compilers (for example kotlinc) emit
LocalVariableTable entries for slots that no
// instruction in the method body ever touches. setMaxLocals() must
not shrink maxLocals below
// what those entries require, or the resulting class file fails
verification with a
// "Invalid index ... in LocalVariableTable" ClassFormatError.
@@ -164,7 +164,7 @@ class MethodGenTest {
mg.addLocalVariable("unusedByCompiler", Type.INT, 6, start, end);
assertEquals(7, mg.getMaxLocals(), "addLocalVariable() should already
have grown maxLocals");
- // Simulate a later pass (e.g. instrumentation) recomputing maxLocals
from the instruction list.
+ // Simulate a later pass (for example instrumentation) recomputing
maxLocals from the instruction list.
mg.setMaxLocals();
assertEquals(7, mg.getMaxLocals(), "setMaxLocals() dropped a local
variable table entry unreferenced by instructions");
