Javadoc

Author: garydgregory

src/examples/ClassDumper.java

@@ -43,7 +43,7 @@ final class ClassDumper {
     private int[] interfaces; // Names of implemented interfaces
     private ConstantPool constantPool; // collection of constants
     private Constant[] constantItems; // collection of constants
-    // private Field[] fields; // class fields, i.e., its variables
+    // private Field[] fields; // class fields, that is, its variables
     // private Method[] methods; // methods defined in the class
     private Attribute[] attributes; // attributes defined in the class
 
@@ -64,7 +64,7 @@ private String constantToString(final int index) {
     }
 
     /**
-     * Parses the given Java class file and return an object that represents the contained data, i.e., constants, methods,
+     * Parses the given Java class file and return an object that represents the contained data, that is, constants, methods,
      * fields and commands. A <em>ClassFormatException</em> is raised, if the file is not a valid .class file. (This does
      * not include verification of the byte code as it is performed by the Java interpreter).
      *
@@ -81,11 +81,11 @@ public void dump() throws IOException, ClassFormatException {
             processConstantPool();
             // Get class information
             processClassInfo();
-            // Get interface information, i.e., implemented interfaces
+            // Get interface information, that is, implemented interfaces
             processInterfaces();
-            // process class fields, i.e., the variables of the class
+            // process class fields, that is, the variables of the class
             processFields();
-            // process class methods, i.e., the functions in the class
+            // process class methods, that is, the functions in the class
             processMethods();
             // process class attributes
             processAttributes();
@@ -241,7 +241,7 @@ private void processFieldOrMethod() throws IOException, ClassFormatException {
     }
 
     /**
-     * Processes information about the fields of the class, i.e., its variables.
+     * Processes information about the fields of the class, that is, its variables.
      *
      * @throws IOException if an I/O error occurs.
      * @throws ClassFormatException

src/examples/Mini/ParseException.java

@@ -60,7 +60,7 @@ public class ParseException extends Exception {
 
     /**
      * The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in
-     * this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields
+     * this manner makes the exception behave in the normal way - that is, as documented in the class "Throwable". The fields
      * "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated
      * code does not use these constructors.
      */

src/main/java/org/apache/bcel/Const.java

@@ -2908,7 +2908,7 @@ public final class Const {
             ILLEGAL_TYPE, ILLEGAL_TYPE, ILLEGAL_TYPE };
 
     /**
-     * Number of byte code operands for each opcode, i.e., number of bytes after the tag byte itself. Indexed by opcode, so NO_OF_OPERANDS[BIPUSH] = the number
+     * Number of byte code operands for each opcode, that is, number of bytes after the tag byte itself. Indexed by opcode, so NO_OF_OPERANDS[BIPUSH] = the number
      * of operands for a bipush instruction.
      */
     static final short[] NO_OF_OPERANDS = { 0/* nop */, 0/* aconst_null */, 0/* iconst_m1 */, 0/* iconst_0 */, 0/* iconst_1 */, 0/* iconst_2 */,

src/main/java/org/apache/bcel/Constants.java

@@ -2368,7 +2368,7 @@ public interface Constants {
         ILLEGAL_TYPE, ILLEGAL_TYPE};
 
     /**
-     * Number of byte code operands for each opcode, i.e., number of bytes after the tag byte itself. Indexed by opcode, so
+     * Number of byte code operands for each opcode, that is, number of bytes after the tag byte itself. Indexed by opcode, so
      * NO_OF_OPERANDS[BIPUSH] = the number of operands for a bipush instruction.
      */
     short[] NO_OF_OPERANDS = Const.NO_OF_OPERANDS;

src/main/java/org/apache/bcel/Repository.java

@@ -80,15 +80,15 @@ public static org.apache.bcel.util.Repository getRepository() {
     }
 
     /**
-     * @return list of super classes of clazz in ascending order, i.e., Object is always the last element
+     * @return list of super classes of clazz in ascending order, that is, Object is always the last element
      * @throws ClassNotFoundException if any of the superclasses can't be found
      */
     public static JavaClass[] getSuperClasses(final JavaClass clazz) throws ClassNotFoundException {
         return clazz.getSuperClasses();
     }
 
     /**
-     * @return list of super classes of clazz in ascending order, i.e., Object is always the last element.
+     * @return list of super classes of clazz in ascending order, that is, Object is always the last element.
      * @throws ClassNotFoundException if the named class or any of its superclasses can't be found
      */
     public static JavaClass[] getSuperClasses(final String className) throws ClassNotFoundException {

src/main/java/org/apache/bcel/classfile/Attribute.java

@@ -286,7 +286,7 @@ protected Attribute(final byte tag, final int nameIndex, final int length, final
     public abstract void accept(Visitor v);
 
     /**
-     * Use copy() if you want to have a deep copy(), i.e., with all references copied correctly.
+     * Use copy() if you want to have a deep copy(), that is, with all references copied correctly.
      *
      * @return shallow copy of this attribute
      */
@@ -359,9 +359,9 @@ public final int getNameIndex() {
     }
 
     /**
-     * Gets the tag of attribute, i.e., its type.
+     * Gets the tag of attribute, that is, its type.
      *
-     * @return Tag of attribute, i.e., its type. Value may not be altered, thus there is no setTag() method.
+     * @return Tag of attribute, that is, its type. Value may not be altered, thus there is no setTag() method.
      */
     public final byte getTag() {
         return tag;

src/main/java/org/apache/bcel/classfile/BootstrapMethod.java

@@ -28,7 +28,7 @@
 import org.apache.commons.lang3.ArrayUtils;
 
 /**
- * This class represents a bootstrap method attribute, i.e., the bootstrap method ref, the number of bootstrap arguments
+ * This class represents a bootstrap method attribute, that is, the bootstrap method ref, the number of bootstrap arguments
  * and an array of the bootstrap arguments.
  *
  * @see <a href="https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.7.23"> The class File Format :

src/main/java/org/apache/bcel/classfile/ClassParser.java

@@ -52,7 +52,7 @@ public final class ClassParser {
     private int accessFlags; // Access rights of parsed class
     private int[] interfaces; // Names of implemented interfaces
     private ConstantPool constantPool; // collection of constants
-    private Field[] fields; // class fields, i.e., its variables
+    private Field[] fields; // class fields, that is, its variables
     private Method[] methods; // methods defined in the class
     private Attribute[] attributes; // attributes defined in the class
     private final boolean isZip; // Loaded from ZIP file
@@ -100,7 +100,7 @@ public ClassParser(final String zipFile, final String fileName) {
     }
 
     /**
-     * Parses the given Java class file and return an object that represents the contained data, i.e., constants, methods,
+     * Parses the given Java class file and return an object that represents the contained data, that is, constants, methods,
      * fields and commands. A <em>ClassFormatException</em> is raised, if the file is not a valid .class file. (This does
      * not include verification of the byte code as it is performed by the Java interpreter).
      *
@@ -135,12 +135,12 @@ public JavaClass parse() throws IOException, ClassFormatException {
             readConstantPool();
             // Get class information
             readClassInfo();
-            // Get interface information, i.e., implemented interfaces
+            // Get interface information, that is, implemented interfaces
             readInterfaces();
             // -- Read class fields and methods --
-            // Read class fields, i.e., the variables of the class
+            // Read class fields, that is, the variables of the class
             readFields();
-            // Read class methods, i.e., the functions in the class
+            // Read class methods, that is, the functions in the class
             readMethods();
             // Read class attributes
             readAttributes();
@@ -216,7 +216,7 @@ private void readConstantPool() throws IOException, ClassFormatException {
     }
 
     /**
-     * Reads information about the fields of the class, i.e., its variables.
+     * Reads information about the fields of the class, that is, its variables.
      *
      * @throws IOException if an I/O error occurs.
      * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file

src/main/java/org/apache/bcel/classfile/Code.java

@@ -97,7 +97,7 @@ public Code(final Code code) {
         code = new byte[codeLength]; // Read byte code
         dataInput.readFully(code);
         /*
-         * Read exception table that contains all regions where an exception handler is active, i.e., a try { ... } catch () block.
+         * Read exception table that contains all regions where an exception handler is active, that is, a try { ... } catch () block.
          */
         final int exceptionTableLength = dataInput.readUnsignedShort();
         exceptionTable = new CodeException[exceptionTableLength];
@@ -149,7 +149,7 @@ public Code(final int nameIndex, final int length, final int maxStack, final int
      * 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.
      *
-     * @param v Visitor object
+     * @param v Visitor object.
      */
     @Override
     public void accept(final Visitor v) {
@@ -193,7 +193,7 @@ public Attribute copy(final ConstantPool constantPool) {
     /**
      * Dumps code attribute to file stream in binary format.
      *
-     * @param file Output file stream
+     * @param file Output file stream.
      * @throws IOException if an I/O error occurs.
      */
     @Override

src/main/java/org/apache/bcel/classfile/CodeException.java

@@ -66,7 +66,7 @@ public final class CodeException implements Cloneable, Node, Constants {
     private int endPc;
 
     /**
-     * Starting address of exception handler, i.e., an offset from start of code.
+     * Starting address of exception handler, that is, an offset from start of code.
      */
     private int handlerPc;
 
@@ -99,7 +99,7 @@ public CodeException(final CodeException c) {
      *
      * @param startPc Range in the code the exception handler is active, startPc is inclusive while
      * @param endPc is exclusive
-     * @param handlerPc Starting address of exception handler, i.e., an offset from start of code.
+     * @param handlerPc Starting address of exception handler, that is, an offset from start of code.
      * @param catchType If zero the handler catches any exception, otherwise it points to the exception class which is to be
      *        caught.
      */