Javadoc

Author: garydgregory

src/examples/HelloWorldBuilder.java

@@ -79,12 +79,12 @@ public static void main(final String[] argv) {
 
         // Create BufferedReader object and store it in local variable 'in'.
         il.append(factory.createNew("java.io.BufferedReader"));
-        il.append(InstructionConst.DUP); // Use predefined constant, i.e. flyweight
+        il.append(InstructionConst.DUP); // Use predefined constant, for example flyweight
         il.append(factory.createNew("java.io.InputStreamReader"));
         il.append(InstructionConst.DUP);
         il.append(factory.createFieldAccess("java.lang.System", "in", iStream, Const.GETSTATIC));
 
-        // Call constructors, i.e. BufferedReader(InputStreamReader())
+        // Call constructors, for example BufferedReader(InputStreamReader())
         il.append(factory.createInvoke("java.io.InputStreamReader", "<init>", Type.VOID, new Type[] {iStream}, Const.INVOKESPECIAL));
         il.append(factory.createInvoke("java.io.BufferedReader", "<init>", Type.VOID, new Type[] {new ObjectType("java.io.Reader")}, Const.INVOKESPECIAL));
 
@@ -147,7 +147,7 @@ public static void main(final String[] argv) {
 
         il.dispose(); // Reuse instruction handles
 
-        // Add public <init> method, i.e. empty constructor
+        // Add public <init> method, for example empty constructor
         cg.addEmptyConstructor(Const.ACC_PUBLIC);
 
         // Get JavaClass object and dump it to file.

src/examples/JasminVisitor.java

@@ -160,7 +160,7 @@ public void visitCode(final Code code) {
         final InstructionHandle[] ihs = il.getInstructionHandles();
 
         /*
-         * Pass 1: Give all referenced instruction handles a symbolic name, i.e. a label.
+         * Pass 1: Give all referenced instruction handles a symbolic name, for example a label.
          */
         map = new Hashtable<>();
 

src/examples/Mini/ASTExpr.java

@@ -38,7 +38,7 @@
 
 /**
  * Represents arithmetic expressions such as '(a + 12 == b) OR c'. The parse tree is built initially by the parser and
- * modified, i.e. compacted with 'traverse()'. Each (Expr, Term, Factor) node with kind == -1 is replaced which its
+ * modified, for example compacted with 'traverse()'. Each (Expr, Term, Factor) node with kind == -1 is replaced which its
  * successor node, which is converted to type 'Expr'
  *
  * A node with kind == -1 denotes the fact that this expression node has just one child branch and thus may be replaced

src/examples/Mini/ASTIfExpr.java

@@ -63,7 +63,7 @@ public void byte_code(final InstructionList il, final MethodGen method, final Co
 
         BranchHandle i, g;
 
-        i = il.append(new IFEQ(null)); // If POP() == FALSE(i.e. 0) then branch to ELSE
+        i = il.append(new IFEQ(null)); // If POP() == FALSE(for example 0) then branch to ELSE
         ASTFunDecl.pop();
         il.append(then_code);
         g = il.append(new GOTO(null));

src/examples/Mini/ASTProgram.java

@@ -258,7 +258,7 @@ public void eval(final int pass) {
     /**
      * First pass of parse tree.
      *
-     * Put everything into the environment, which is copied appropriately to each recursion level, i.e. each FunDecl gets its
+     * Put everything into the environment, which is copied appropriately to each recursion level, for example each FunDecl gets its
      * own copy that it can further manipulate.
      *
      * Checks for name clashes of function declarations.

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

@@ -79,14 +79,18 @@ public final void dump(final DataOutputStream dos) throws IOException {
     }
 
     /**
-     * @return the default value
+     * Gets the default value.
+     *
+     * @return the default value.
      */
     public final ElementValue getDefaultValue() {
         return defaultValue;
     }
 
     /**
-     * @param defaultValue the default value of this methodinfo's annotation
+     * Sets the default value of this methodinfo's annotation.
+     *
+     * @param defaultValue the default value of this methodinfo's annotation.
      */
     public final void setDefaultValue(final ElementValue defaultValue) {
         this.defaultValue = defaultValue;

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

@@ -22,12 +22,21 @@
 import java.io.IOException;
 
 /**
+ * Represents an annotation element value.
+ *
  * @since 6.0
  */
 public class AnnotationElementValue extends ElementValue {
     // For annotation element values, this is the annotation
     private final AnnotationEntry annotationEntry;
 
+    /**
+     * Constructs an AnnotationElementValue.
+     *
+     * @param type the type.
+     * @param annotationEntry the annotation entry.
+     * @param cpool the constant pool.
+     */
     public AnnotationElementValue(final int type, final AnnotationEntry annotationEntry, final ConstantPool cpool) {
         super(type, cpool);
         if (type != ANNOTATION) {
@@ -42,6 +51,11 @@ public void dump(final DataOutputStream dos) throws IOException {
         annotationEntry.dump(dos);
     }
 
+    /**
+     * Gets the annotation entry.
+     *
+     * @return the annotation entry.
+     */
     public AnnotationEntry getAnnotationEntry() {
         return annotationEntry;
     }

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

@@ -43,12 +43,12 @@ public static AnnotationEntry[] createAnnotationEntries(final Attribute[] attrib
     }
 
     /**
-     * Factory method to create an AnnotionEntry from a DataInput
+     * Factory method to create an AnnotionEntry from a DataInput.
      *
-     * @param input
-     * @param constantPool
-     * @param isRuntimeVisible
-     * @return the entry
+     * @param input the input stream.
+     * @param constantPool the constant pool.
+     * @param isRuntimeVisible whether the annotation is runtime visible.
+     * @return the entry.
      * @throws IOException if an I/O error occurs.
      */
     public static AnnotationEntry read(final DataInput input, final ConstantPool constantPool, final boolean isRuntimeVisible) throws IOException {
@@ -87,10 +87,21 @@ public void accept(final Visitor v) {
         v.visitAnnotationEntry(this);
     }
 
+    /**
+     * Adds an element name value pair.
+     *
+     * @param elementNameValuePair the element name value pair.
+     */
     public void addElementNameValuePair(final ElementValuePair elementNameValuePair) {
         elementValuePairs.add(elementNameValuePair);
     }
 
+    /**
+     * Dumps this annotation entry to a DataOutputStream.
+     *
+     * @param dos the output stream.
+     * @throws IOException if an I/O error occurs.
+     */
     public void dump(final DataOutputStream dos) throws IOException {
         dos.writeShort(typeIndex); // u2 index of type name in cpool
         dos.writeShort(elementValuePairs.size()); // u2 element_value pair
@@ -101,46 +112,74 @@ public void dump(final DataOutputStream dos) throws IOException {
     }
 
     /**
-     * @return the annotation type name
+     * Gets the annotation type name.
+     *
+     * @return the annotation type name.
      */
     public String getAnnotationType() {
         return constantPool.getConstantUtf8(typeIndex).getBytes();
     }
 
     /**
-     * @return the annotation type index
+     * Gets the annotation type index.
+     *
+     * @return the annotation type index.
      */
     public int getAnnotationTypeIndex() {
         return typeIndex;
     }
 
+    /**
+     * Gets the constant pool.
+     *
+     * @return the constant pool.
+     */
     public ConstantPool getConstantPool() {
         return constantPool;
     }
 
     /**
-     * @return the element value pairs in this annotation entry
+     * Gets the element value pairs in this annotation entry.
+     *
+     * @return the element value pairs in this annotation entry.
      */
     public ElementValuePair[] getElementValuePairs() {
         // TODO return List
         return elementValuePairs.toArray(ElementValuePair.EMPTY_ARRAY);
     }
 
     /**
-     * @return the number of element value pairs in this annotation entry
+     * Gets the number of element value pairs in this annotation entry.
+     *
+     * @return the number of element value pairs in this annotation entry.
      */
     public final int getNumElementValuePairs() {
         return elementValuePairs.size();
     }
 
+    /**
+     * Gets the type index.
+     *
+     * @return the type index.
+     */
     public int getTypeIndex() {
         return typeIndex;
     }
 
+    /**
+     * Gets whether this annotation is runtime visible.
+     *
+     * @return true if this annotation is runtime visible.
+     */
     public boolean isRuntimeVisible() {
         return isRuntimeVisible;
     }
 
+    /**
+     * Gets a short string representation of this annotation.
+     *
+     * @return a short string representation of this annotation.
+     */
     public String toShortString() {
         final StringBuilder result = new StringBuilder();
         result.append("@");

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

@@ -22,6 +22,8 @@
 import java.io.IOException;
 
 /**
+ * Represents an array element value in an annotation.
+ *
  * @since 6.0
  */
 public class ArrayElementValue extends ElementValue {

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

@@ -90,6 +90,11 @@ public static void addAttributeReader(final String name, final UnknownAttributeR
         READERS.put(name, unknownAttributeReader);
     }
 
+    /**
+     * Prints a message to stderr if debug mode is enabled.
+     *
+     * @param msg the message to print.
+     */
     protected static void println(final String msg) {
         if (debug) {
             System.err.println(msg);
@@ -297,6 +302,8 @@ public Object clone() {
     }
 
     /**
+     * Creates a deep copy of this attribute.
+     *
      * @param constantPool constant pool to save.
      * @return deep copy of this attribute.
      */
@@ -314,6 +321,8 @@ public void dump(final DataOutputStream file) throws IOException {
     }
 
     /**
+     * Gets the constant pool used by this object.
+     *
      * @return Constant pool used by this object.
      * @see ConstantPool
      */
@@ -322,35 +331,45 @@ public final ConstantPool getConstantPool() {
     }
 
     /**
+     * Gets the length of attribute field in bytes.
+     *
      * @return Length of attribute field in bytes.
      */
     public final int getLength() {
         return length;
     }
 
     /**
-     * @return Name of attribute
+     * Gets the name of attribute.
+     *
+     * @return Name of attribute.
      * @since 6.0
      */
     public String getName() {
         return constant_pool.getConstantUtf8(name_index).getBytes();
     }
 
     /**
+     * Gets the name index in constant pool of attribute name.
+     *
      * @return Name index in constant pool of attribute name.
      */
     public final int getNameIndex() {
         return name_index;
     }
 
     /**
+     * Gets the tag of attribute, i.e., its type.
+     *
      * @return Tag of attribute, i.e., its type. Value may not be altered, thus there is no setTag() method.
      */
     public final byte getTag() {
         return tag;
     }
 
     /**
+     * Sets the constant pool to be used for this object.
+     *
      * @param constantPool Constant pool to be used for this object.
      * @see ConstantPool
      */
@@ -359,13 +378,17 @@ public final void setConstantPool(final ConstantPool constantPool) {
     }
 
     /**
+     * Sets the length in bytes.
+     *
      * @param length length in bytes.
      */
     public final void setLength(final int length) {
         this.length = length;
     }
 
     /**
+     * Sets the name index of attribute.
+     *
      * @param nameIndex of attribute.
      */
     public final void setNameIndex(final int nameIndex) {