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 940d2d0d Javadoc
940d2d0d is described below
commit 940d2d0ddcd90ed0c5b41d731c3939acad4840de
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:15:07 2026 -0400
Javadoc
---
src/main/java/org/apache/bcel/Const.java | 24 +++++-----
src/main/java/org/apache/bcel/ExceptionConst.java | 2 +-
.../apache/bcel/classfile/AnnotationDefault.java | 2 +-
.../bcel/classfile/AnnotationElementValue.java | 2 +-
.../org/apache/bcel/classfile/AnnotationEntry.java | 16 +++----
.../org/apache/bcel/classfile/Annotations.java | 4 +-
.../apache/bcel/classfile/ArrayElementValue.java | 4 +-
.../apache/bcel/classfile/ClassElementValue.java | 4 +-
src/main/java/org/apache/bcel/classfile/Code.java | 4 +-
.../bcel/classfile/ConstantMethodHandle.java | 4 +-
.../apache/bcel/classfile/ConstantMethodType.java | 2 +-
.../org/apache/bcel/classfile/ElementValue.java | 6 +--
.../apache/bcel/classfile/ElementValuePair.java | 6 +--
.../org/apache/bcel/classfile/EnclosingMethod.java | 8 ++--
.../apache/bcel/classfile/EnumElementValue.java | 8 ++--
.../org/apache/bcel/classfile/FieldOrMethod.java | 2 +-
.../java/org/apache/bcel/classfile/JavaClass.java | 6 +--
.../org/apache/bcel/classfile/LineNumberTable.java | 2 +-
.../apache/bcel/classfile/LocalVariableTable.java | 6 +--
.../bcel/classfile/LocalVariableTypeTable.java | 6 +--
.../org/apache/bcel/classfile/MethodParameter.java | 4 +-
.../apache/bcel/classfile/MethodParameters.java | 2 +-
.../org/apache/bcel/classfile/ModuleExports.java | 4 +-
.../org/apache/bcel/classfile/ModuleOpens.java | 4 +-
.../org/apache/bcel/classfile/ModuleRequires.java | 2 +-
.../bcel/classfile/ParameterAnnotationEntry.java | 4 +-
.../bcel/classfile/ParameterAnnotations.java | 4 +-
.../java/org/apache/bcel/classfile/Signature.java | 2 +-
.../apache/bcel/classfile/SimpleElementValue.java | 18 ++++----
.../java/org/apache/bcel/classfile/StackMap.java | 2 +-
.../org/apache/bcel/classfile/StackMapEntry.java | 12 ++---
.../org/apache/bcel/classfile/StackMapType.java | 4 +-
.../java/org/apache/bcel/classfile/Utility.java | 14 +++---
.../bcel/generic/AnnotationElementValueGen.java | 2 +-
.../apache/bcel/generic/AnnotationEntryGen.java | 8 ++--
.../apache/bcel/generic/ArrayElementValueGen.java | 4 +-
.../java/org/apache/bcel/generic/BasicType.java | 2 +-
.../org/apache/bcel/generic/BranchInstruction.java | 6 +--
.../apache/bcel/generic/ClassElementValueGen.java | 4 +-
.../java/org/apache/bcel/generic/ClassGen.java | 28 +++++------
.../org/apache/bcel/generic/CodeExceptionGen.java | 4 +-
.../apache/bcel/generic/CompoundInstruction.java | 2 +-
.../bcel/generic/ConstantPushInstruction.java | 2 +-
.../org/apache/bcel/generic/ElementValueGen.java | 6 +--
.../apache/bcel/generic/ElementValuePairGen.java | 6 +--
.../apache/bcel/generic/EnumElementValueGen.java | 8 ++--
.../org/apache/bcel/generic/ExceptionThrower.java | 2 +-
.../java/org/apache/bcel/generic/FieldGen.java | 4 +-
.../apache/bcel/generic/FieldGenOrMethodGen.java | 2 +-
.../org/apache/bcel/generic/INVOKEINTERFACE.java | 2 +-
.../apache/bcel/generic/IndexedInstruction.java | 2 +-
.../java/org/apache/bcel/generic/Instruction.java | 2 +-
.../org/apache/bcel/generic/InstructionConst.java | 2 +-
.../apache/bcel/generic/InstructionFactory.java | 54 +++++++++++-----------
.../org/apache/bcel/generic/InstructionHandle.java | 16 +++----
.../org/apache/bcel/generic/InstructionList.java | 2 +-
src/main/java/org/apache/bcel/generic/LDC.java | 2 +-
src/main/java/org/apache/bcel/generic/LDC2_W.java | 2 +-
.../org/apache/bcel/generic/LineNumberGen.java | 6 +--
.../java/org/apache/bcel/generic/LoadClass.java | 2 +-
.../org/apache/bcel/generic/LocalVariableGen.java | 10 ++--
.../java/org/apache/bcel/generic/MethodGen.java | 12 ++---
.../bcel/generic/NameSignatureInstruction.java | 2 +-
.../org/apache/bcel/generic/NamedAndTyped.java | 4 +-
src/main/java/org/apache/bcel/generic/PUSH.java | 2 +-
.../org/apache/bcel/generic/ReferenceType.java | 4 +-
.../org/apache/bcel/generic/ReturnInstruction.java | 2 +-
.../org/apache/bcel/generic/ReturnaddressType.java | 2 +-
src/main/java/org/apache/bcel/generic/SWITCH.java | 2 +-
src/main/java/org/apache/bcel/generic/Select.java | 6 +--
.../apache/bcel/generic/SimpleElementValueGen.java | 8 ++--
src/main/java/org/apache/bcel/generic/Type.java | 6 +--
.../org/apache/bcel/generic/TypedInstruction.java | 2 +-
.../bcel/util/AbstractClassPathRepository.java | 2 +-
src/main/java/org/apache/bcel/util/BCELifier.java | 2 +-
.../java/org/apache/bcel/util/ByteSequence.java | 2 +-
.../java/org/apache/bcel/util/ClassLoader.java | 4 +-
src/main/java/org/apache/bcel/util/ClassQueue.java | 2 +-
src/main/java/org/apache/bcel/util/ClassSet.java | 2 +-
src/main/java/org/apache/bcel/util/ClassStack.java | 4 +-
.../java/org/apache/bcel/util/ClassVector.java | 2 +-
.../org/apache/bcel/util/InstructionFinder.java | 4 +-
.../org/apache/bcel/util/ModularRuntimeImage.java | 2 +-
src/main/java/org/apache/bcel/util/Repository.java | 8 ++--
.../org/apache/bcel/util/SyntheticRepository.java | 4 +-
.../org/apache/bcel/verifier/PassVerifier.java | 4 +-
.../apache/bcel/verifier/VerificationResult.java | 4 +-
.../java/org/apache/bcel/verifier/Verifier.java | 12 ++---
.../org/apache/bcel/verifier/VerifierAppFrame.java | 2 +-
.../org/apache/bcel/verifier/VerifierFactory.java | 2 +-
.../verifier/exc/AssertionViolatedException.java | 2 +-
.../java/org/apache/bcel/verifier/exc/Utility.java | 2 +-
.../exc/VerifierConstraintViolatedException.java | 2 +-
.../apache/bcel/verifier/statics/DOUBLE_Upper.java | 2 +-
.../apache/bcel/verifier/statics/LONG_Upper.java | 2 +-
.../bcel/verifier/statics/LocalVariableInfo.java | 4 +-
.../bcel/verifier/statics/Pass2Verifier.java | 2 +-
.../bcel/verifier/statics/Pass3aVerifier.java | 8 ++--
.../verifier/structurals/ControlFlowGraph.java | 4 +-
.../verifier/structurals/ExceptionHandler.java | 4 +-
.../apache/bcel/verifier/structurals/Frame.java | 6 +--
.../verifier/structurals/InstructionContext.java | 10 ++--
.../bcel/verifier/structurals/LocalVariables.java | 4 +-
.../bcel/verifier/structurals/OperandStack.java | 12 ++---
.../bcel/verifier/structurals/Pass3bVerifier.java | 8 ++--
.../bcel/verifier/structurals/Subroutines.java | 6 +--
.../structurals/UninitializedObjectType.java | 2 +-
107 files changed, 290 insertions(+), 290 deletions(-)
diff --git a/src/main/java/org/apache/bcel/Const.java
b/src/main/java/org/apache/bcel/Const.java
index 357534ee..9986edae 100644
--- a/src/main/java/org/apache/bcel/Const.java
+++ b/src/main/java/org/apache/bcel/Const.java
@@ -3308,7 +3308,7 @@ public final class Const {
* Gets the access name at the given index.
*
* @param index index into {@code ACCESS_NAMES}.
- * @return the ACCESS_NAMES entry at the given index.
+ * @return The ACCESS_NAMES entry at the given index.
* @since 6.0
*/
public static String getAccessName(final int index) {
@@ -3319,7 +3319,7 @@ public final class Const {
* Gets the attribute name at the given index.
*
* @param index index into {@code ACCESS_NAMES}.
- * @return the attribute name.
+ * @return The attribute name.
* @since 6.0
*/
public static String getAttributeName(final int index) {
@@ -3330,7 +3330,7 @@ public final class Const {
* The primitive class names corresponding to the T_XX constants, for
example, CLASS_TYPE_NAMES[T_INT] = "java.lang.Integer".
*
* @param index index into {@code CLASS_TYPE_NAMES}.
- * @return the class name.
+ * @return The class name.
* @since 6.0
*/
public static String getClassTypeName(final int index) {
@@ -3341,7 +3341,7 @@ public final class Const {
* Gets the constant name at the given index.
*
* @param index index into {@code CONSTANT_NAMES}.
- * @return the CONSTANT_NAMES entry at the given index.
+ * @return The CONSTANT_NAMES entry at the given index.
* @since 6.0
*/
public static String getConstantName(final int index) {
@@ -3363,7 +3363,7 @@ public final class Const {
/**
* Gets the interfaces implemented by arrays.
*
- * @return the interfaces implemented by arrays.
+ * @return The interfaces implemented by arrays.
* @since 6.0
*/
public static Iterable<String> getInterfacesImplementedByArrays() {
@@ -3374,7 +3374,7 @@ public final class Const {
* Gets the item name at the given index.
*
* @param index index into {@code ITEM_NAMES}.
- * @return the item name.
+ * @return The item name.
* @since 6.0
*/
public static String getItemName(final int index) {
@@ -3385,7 +3385,7 @@ public final class Const {
* Gets the method handle name at the given index.
*
* @param index index into {@code METHODHANDLE_NAMES}.
- * @return the method handle name.
+ * @return The method handle name.
* @since 6.0
*/
public static String getMethodHandleName(final int index) {
@@ -3407,7 +3407,7 @@ public final class Const {
* Gets the opcode name at the given index.
*
* @param index the index.
- * @return the opcode name.
+ * @return The opcode name.
* @since 6.0
*/
public static String getOpcodeName(final int index) {
@@ -3419,7 +3419,7 @@ public final class Const {
*
* @param opcode the opcode.
* @param index the index.
- * @return the operand type.
+ * @return The operand type.
* @since 6.0
*/
public static short getOperandType(final int opcode, final int index) {
@@ -3430,7 +3430,7 @@ public final class Const {
* Gets the operand type count.
*
* @param opcode the opcode.
- * @return the operand type count.
+ * @return The operand type count.
* @since 6.0
*/
public static long getOperandTypeCount(final int opcode) {
@@ -3452,7 +3452,7 @@ public final class Const {
* Gets the short type name at the given index.
*
* @param index the index.
- * @return the short type name.
+ * @return The short type name.
* @since 6.0
*/
public static String getShortTypeName(final int index) {
@@ -3463,7 +3463,7 @@ public final class Const {
* The primitive type names corresponding to the T_XX constants, for
example, TYPE_NAMES[T_INT] = "int".
*
* @param index the index.
- * @return the type name.
+ * @return The type name.
* @since 6.0
*/
public static String getTypeName(final int index) {
diff --git a/src/main/java/org/apache/bcel/ExceptionConst.java
b/src/main/java/org/apache/bcel/ExceptionConst.java
index 7451286c..34a627ed 100644
--- a/src/main/java/org/apache/bcel/ExceptionConst.java
+++ b/src/main/java/org/apache/bcel/ExceptionConst.java
@@ -154,7 +154,7 @@ public final class ExceptionConst {
*
* @param type the basic array type.
* @param extraClasses additional classes, if any.
- * @return the merged array.
+ * @return The merged array.
*/
public static Class<?>[] createExceptions(final EXCS type, final
Class<?>... extraClasses) {
switch (type) {
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
index 312911ff..893dfd6e 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationDefault.java
@@ -83,7 +83,7 @@ public class AnnotationDefault extends Attribute {
/**
* Gets the default value.
*
- * @return the default value.
+ * @return The default value.
*/
public final ElementValue getDefaultValue() {
return defaultValue;
diff --git
a/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
b/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
index a42e4cc6..994bc595 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationElementValue.java
@@ -54,7 +54,7 @@ public class AnnotationElementValue extends ElementValue {
/**
* Gets the annotation entry.
*
- * @return the annotation entry.
+ * @return The annotation entry.
*/
public AnnotationEntry getAnnotationEntry() {
return annotationEntry;
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
index 4bd0e8d3..4ad94058 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
@@ -43,7 +43,7 @@ public class AnnotationEntry implements Node {
* Creates annotation entries from attributes.
*
* @param attributes the attributes.
- * @return the annotation entries.
+ * @return The annotation entries.
*/
public static AnnotationEntry[] createAnnotationEntries(final Attribute[]
attributes) {
// Find attributes that contain annotation data
@@ -57,7 +57,7 @@ public class AnnotationEntry implements Node {
* @param input the input stream.
* @param constantPool the constant pool.
* @param isRuntimeVisible whether the annotation is runtime visible.
- * @return the entry.
+ * @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 {
@@ -130,7 +130,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the annotation type name.
*
- * @return the annotation type name.
+ * @return The annotation type name.
*/
public String getAnnotationType() {
return constantPool.getConstantUtf8(typeIndex).getBytes();
@@ -139,7 +139,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the annotation type index.
*
- * @return the annotation type index.
+ * @return The annotation type index.
*/
public int getAnnotationTypeIndex() {
return typeIndex;
@@ -148,7 +148,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the constant pool.
*
- * @return the constant pool.
+ * @return The constant pool.
*/
public ConstantPool getConstantPool() {
return constantPool;
@@ -157,7 +157,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the element value pairs in this annotation entry.
*
- * @return the element value pairs in this annotation entry.
+ * @return The element value pairs in this annotation entry.
*/
public ElementValuePair[] getElementValuePairs() {
// TODO return List
@@ -167,7 +167,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the number of element value pairs in this annotation entry.
*
- * @return 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();
@@ -176,7 +176,7 @@ public class AnnotationEntry implements Node {
/**
* Gets the type index.
*
- * @return the type index.
+ * @return The type index.
*/
public int getTypeIndex() {
return typeIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/Annotations.java
b/src/main/java/org/apache/bcel/classfile/Annotations.java
index 570c72bb..ea6eefff 100644
--- a/src/main/java/org/apache/bcel/classfile/Annotations.java
+++ b/src/main/java/org/apache/bcel/classfile/Annotations.java
@@ -95,7 +95,7 @@ public abstract class Annotations extends Attribute
implements Iterable<Annotati
/**
* Gets the array of annotation entries in this annotation.
*
- * @return the array of annotation entries in this annotation.
+ * @return The array of annotation entries in this annotation.
*/
public AnnotationEntry[] getAnnotationEntries() {
return annotationTable;
@@ -104,7 +104,7 @@ public abstract class Annotations extends Attribute
implements Iterable<Annotati
/**
* Gets the number of annotation entries in this annotation.
*
- * @return the number of annotation entries in this annotation.
+ * @return The number of annotation entries in this annotation.
*/
public final int getNumAnnotations() {
return annotationTable.length;
diff --git a/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
b/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
index dcc93f82..f0f20d39 100644
--- a/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ArrayElementValue.java
@@ -57,7 +57,7 @@ public class ArrayElementValue extends ElementValue {
/**
* Gets the element values array.
*
- * @return the element values array.
+ * @return The element values array.
*/
public ElementValue[] getElementValuesArray() {
return elementValues;
@@ -66,7 +66,7 @@ public class ArrayElementValue extends ElementValue {
/**
* Gets the element values array size.
*
- * @return the element values array size.
+ * @return The element values array size.
*/
public int getElementValuesArraySize() {
return elementValues.length;
diff --git a/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
b/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
index 8e2e15fb..bd61f97a 100644
--- a/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ClassElementValue.java
@@ -53,7 +53,7 @@ public class ClassElementValue extends ElementValue {
/**
* Gets the class string.
*
- * @return the class string.
+ * @return The class string.
*/
public String getClassString() {
return super.getConstantPool().getConstantUtf8(idx).getBytes();
@@ -62,7 +62,7 @@ public class ClassElementValue extends ElementValue {
/**
* Gets the index.
*
- * @return the index.
+ * @return The index.
*/
public int getIndex() {
return idx;
diff --git a/src/main/java/org/apache/bcel/classfile/Code.java
b/src/main/java/org/apache/bcel/classfile/Code.java
index f54ac8a3..84cc6a13 100644
--- a/src/main/java/org/apache/bcel/classfile/Code.java
+++ b/src/main/java/org/apache/bcel/classfile/Code.java
@@ -157,7 +157,7 @@ public final class Code extends Attribute {
}
/**
- * @return the full size of this code attribute, minus its first 6 bytes,
including the size of all its contained attributes.
+ * @return The full size of this code attribute, minus its first 6 bytes,
including the size of all its contained attributes.
*/
private int calculateLength() {
int len = 0;
@@ -244,7 +244,7 @@ public final class Code extends Attribute {
/**
* Gets the internal length of this code attribute (minus the first 6
bytes) and excluding all its attributes.
*
- * @return the internal length of this code attribute (minus the first 6
bytes) and excluding all its attributes.
+ * @return The internal length of this code attribute (minus the first 6
bytes) and excluding all its attributes.
*/
private int getInternalLength() {
return 2 /* maxStack */ + 2 /* maxLocals */ + 4 /* code length */
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
index 058f9fd9..0ceed5ca 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java
@@ -93,7 +93,7 @@ public final class ConstantMethodHandle extends Constant {
/**
* Gets the reference index.
*
- * @return the reference index.
+ * @return The reference index.
*/
public int getReferenceIndex() {
return referenceIndex;
@@ -102,7 +102,7 @@ public final class ConstantMethodHandle extends Constant {
/**
* Gets the reference kind.
*
- * @return the reference kind.
+ * @return The reference kind.
*/
public int getReferenceKind() {
return referenceKind;
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
index 496a2f6f..e6117603 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java
@@ -89,7 +89,7 @@ public final class ConstantMethodType extends Constant {
/**
* Gets the descriptor index.
*
- * @return the descriptor index.
+ * @return The descriptor index.
*/
public int getDescriptorIndex() {
return descriptorIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/ElementValue.java
b/src/main/java/org/apache/bcel/classfile/ElementValue.java
index cd576bb6..3eb9f79a 100644
--- a/src/main/java/org/apache/bcel/classfile/ElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ElementValue.java
@@ -197,7 +197,7 @@ public abstract class ElementValue {
/**
* Gets the constant pool.
*
- * @return the constant pool.
+ * @return The constant pool.
* @since 6.0
*/
final ConstantPool getConstantPool() {
@@ -207,7 +207,7 @@ public abstract class ElementValue {
/**
* Gets the element value type.
*
- * @return the element value type.
+ * @return The element value type.
*/
public int getElementValueType() {
return type;
@@ -216,7 +216,7 @@ public abstract class ElementValue {
/**
* Gets the type.
*
- * @return the type.
+ * @return The type.
* @since 6.0
*/
final int getType() {
diff --git a/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
b/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
index fa0dac79..6881db86 100644
--- a/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
+++ b/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
@@ -63,7 +63,7 @@ public class ElementValuePair {
/**
* Gets the name index.
*
- * @return the name index.
+ * @return The name index.
*/
public int getNameIndex() {
return elementNameIndex;
@@ -72,7 +72,7 @@ public class ElementValuePair {
/**
* Gets the name string.
*
- * @return the name string.
+ * @return The name string.
*/
public String getNameString() {
return constantPool.getConstantUtf8(elementNameIndex).getBytes();
@@ -81,7 +81,7 @@ public class ElementValuePair {
/**
* Gets the value.
*
- * @return the element value.
+ * @return The element value.
*/
public final ElementValue getValue() {
return elementValue;
diff --git a/src/main/java/org/apache/bcel/classfile/EnclosingMethod.java
b/src/main/java/org/apache/bcel/classfile/EnclosingMethod.java
index 7220d66d..e67d2d53 100644
--- a/src/main/java/org/apache/bcel/classfile/EnclosingMethod.java
+++ b/src/main/java/org/apache/bcel/classfile/EnclosingMethod.java
@@ -77,7 +77,7 @@ public class EnclosingMethod extends Attribute {
/**
* Gets the enclosing class.
*
- * @return the enclosing class.
+ * @return The enclosing class.
*/
public final ConstantClass getEnclosingClass() {
return super.getConstantPool().getConstant(classIndex,
Const.CONSTANT_Class, ConstantClass.class);
@@ -86,7 +86,7 @@ public class EnclosingMethod extends Attribute {
/**
* Gets the enclosing class index.
*
- * @return the enclosing class index.
+ * @return The enclosing class index.
*/
public final int getEnclosingClassIndex() {
return classIndex;
@@ -95,7 +95,7 @@ public class EnclosingMethod extends Attribute {
/**
* Gets the enclosing method.
*
- * @return the enclosing method.
+ * @return The enclosing method.
*/
public final ConstantNameAndType getEnclosingMethod() {
if (methodIndex == 0) {
@@ -107,7 +107,7 @@ public class EnclosingMethod extends Attribute {
/**
* Gets the enclosing method index.
*
- * @return the enclosing method index.
+ * @return The enclosing method index.
*/
public final int getEnclosingMethodIndex() {
return methodIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
b/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
index 7924ef10..3681aab9 100644
--- a/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/EnumElementValue.java
@@ -59,7 +59,7 @@ public class EnumElementValue extends ElementValue {
/**
* Gets the enum type string.
*
- * @return the enum type string.
+ * @return The enum type string.
*/
public String getEnumTypeString() {
return super.getConstantPool().getConstantUtf8(typeIdx).getBytes();
@@ -68,7 +68,7 @@ public class EnumElementValue extends ElementValue {
/**
* Gets the enum value string.
*
- * @return the enum value string.
+ * @return The enum value string.
*/
public String getEnumValueString() {
return super.getConstantPool().getConstantUtf8(valueIdx).getBytes();
@@ -77,7 +77,7 @@ public class EnumElementValue extends ElementValue {
/**
* Gets the type index.
*
- * @return the type index.
+ * @return The type index.
*/
public int getTypeIndex() {
return typeIdx;
@@ -86,7 +86,7 @@ public class EnumElementValue extends ElementValue {
/**
* Gets the value index.
*
- * @return the value index.
+ * @return The value index.
*/
public int getValueIndex() {
return valueIdx;
diff --git a/src/main/java/org/apache/bcel/classfile/FieldOrMethod.java
b/src/main/java/org/apache/bcel/classfile/FieldOrMethod.java
index 7a42f783..cf4c2668 100644
--- a/src/main/java/org/apache/bcel/classfile/FieldOrMethod.java
+++ b/src/main/java/org/apache/bcel/classfile/FieldOrMethod.java
@@ -217,7 +217,7 @@ public abstract class FieldOrMethod extends AccessFlags
implements Cloneable, No
* (Ljava/util/Vector;)V the signature attribute may in fact say
'Ljava/lang/Vector<Ljava/lang/String>;' Coded for
* performance - searches for the attribute only when requested - only
searches for it once.
*
- * @return the generic signature.
+ * @return The generic signature.
* @since 6.0
*/
public final String getGenericSignature() {
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java
b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index c10ef2e3..6a82cf57 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -624,7 +624,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
/**
* Gets interfaces directly implemented by this JavaClass.
*
- * @return the interfaces.
+ * @return The interfaces.
* @throws ClassNotFoundException if any of the class's interfaces can't
be found.
*/
public JavaClass[] getInterfaces() throws ClassNotFoundException {
@@ -691,7 +691,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
* Gets the ClassRepository which holds its definition. By default this is
the same as
* SyntheticRepository.getInstance().
*
- * @return the repository.
+ * @return The repository.
*/
public org.apache.bcel.util.Repository getRepository() {
return repository;
@@ -734,7 +734,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
/**
* Gets the superclass for this JavaClass object, or null if this is
{@link Object}.
*
- * @return the superclass for this JavaClass object, or null if this is
{@link Object}.
+ * @return The superclass for this JavaClass object, or null if this is
{@link Object}.
* @throws ClassNotFoundException if the superclass can't be found.
*/
public JavaClass getSuperClass() throws ClassNotFoundException {
diff --git a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
index 77e550be..2094f4a1 100644
--- a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java
@@ -183,7 +183,7 @@ public final class LineNumberTable extends Attribute
implements Iterable<LineNum
/**
* Gets the length of the line number table.
*
- * @return the length of the line number table.
+ * @return The length of the line number table.
*/
public int getTableLength() {
return lineNumberTable.length;
diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
index 4a988c8e..3a6e78c3 100644
--- a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java
@@ -125,7 +125,7 @@ public class LocalVariableTable extends Attribute
implements Iterable<LocalVaria
* Gets the local variable for the given index.
*
* @param index the variable slot.
- * @return the first LocalVariable that matches the slot or null if not
found.
+ * @return The first LocalVariable that matches the slot or null if not
found.
* @deprecated Since 5.2 because multiple variables can share the same
slot, use getLocalVariable(int index, int pc) instead.
*/
@java.lang.Deprecated
@@ -143,7 +143,7 @@ public class LocalVariableTable extends Attribute
implements Iterable<LocalVaria
*
* @param index the variable slot.
* @param pc the current pc that this variable is alive.
- * @return the LocalVariable that matches or null if not found.
+ * @return The LocalVariable that matches or null if not found.
*/
public final LocalVariable getLocalVariable(final int index, final int pc)
{
for (final LocalVariable variable : localVariableTable) {
@@ -170,7 +170,7 @@ public class LocalVariableTable extends Attribute
implements Iterable<LocalVaria
/**
* Gets the table length.
*
- * @return the table length.
+ * @return The table length.
*/
public final int getTableLength() {
return localVariableTable.length;
diff --git
a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
index 53650517..fc41345e 100644
--- a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
+++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java
@@ -130,7 +130,7 @@ public class LocalVariableTypeTable extends Attribute
implements Iterable<LocalV
* Gets the local variable for the given index.
*
* @param index the index.
- * @return the local variable or null if not found.
+ * @return The local variable or null if not found.
*/
public final LocalVariable getLocalVariable(final int index) {
for (final LocalVariable variable : localVariableTypeTable) {
@@ -144,7 +144,7 @@ public class LocalVariableTypeTable extends Attribute
implements Iterable<LocalV
/**
* Gets the local variable type table.
*
- * @return the local variable type table.
+ * @return The local variable type table.
*/
public final LocalVariable[] getLocalVariableTypeTable() {
return localVariableTypeTable;
@@ -153,7 +153,7 @@ public class LocalVariableTypeTable extends Attribute
implements Iterable<LocalV
/**
* Gets the table length.
*
- * @return the table length.
+ * @return The table length.
*/
public final int getTableLength() {
return localVariableTypeTable == null ? 0 :
localVariableTypeTable.length;
diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameter.java
b/src/main/java/org/apache/bcel/classfile/MethodParameter.java
index 2ec3c706..e65479ca 100644
--- a/src/main/java/org/apache/bcel/classfile/MethodParameter.java
+++ b/src/main/java/org/apache/bcel/classfile/MethodParameter.java
@@ -94,7 +94,7 @@ public class MethodParameter implements Cloneable, Node {
/**
* Gets the access flags.
*
- * @return the access flags.
+ * @return The access flags.
*/
public int getAccessFlags() {
return accessFlags;
@@ -103,7 +103,7 @@ public class MethodParameter implements Cloneable, Node {
/**
* Gets the name index.
*
- * @return the name index.
+ * @return The name index.
*/
public int getNameIndex() {
return nameIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameters.java
b/src/main/java/org/apache/bcel/classfile/MethodParameters.java
index 607e13cb..e956b18c 100644
--- a/src/main/java/org/apache/bcel/classfile/MethodParameters.java
+++ b/src/main/java/org/apache/bcel/classfile/MethodParameters.java
@@ -85,7 +85,7 @@ public class MethodParameters extends Attribute implements
Iterable<MethodParame
/**
* Gets the method parameters.
*
- * @return the method parameters.
+ * @return The method parameters.
*/
public MethodParameter[] getParameters() {
return parameters;
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleExports.java
b/src/main/java/org/apache/bcel/classfile/ModuleExports.java
index 5dcde7c5..8dffe665 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleExports.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleExports.java
@@ -99,7 +99,7 @@ public final class ModuleExports implements Cloneable, Node {
/**
* Gets the flags for this ModuleExports.
*
- * @return the exportsFlags.
+ * @return The exportsFlags.
* @since 6.10.0
*/
public int getExportsFlags() {
@@ -110,7 +110,7 @@ public final class ModuleExports implements Cloneable, Node
{
* Gets the exported package name.
*
* @param constantPool the constant pool from the ClassFile.
- * @return the exported package name.
+ * @return The exported package name.
* @since 6.10.0
*/
public String getPackageName(final ConstantPool constantPool) {
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
index 57ce8b8a..6fde5151 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java
@@ -99,7 +99,7 @@ public final class ModuleOpens implements Cloneable, Node {
/**
* Gets the flags for this ModuleOpens.
*
- * @return the opensFlags.
+ * @return The opensFlags.
* @since 6.10.0
*/
public int getOpensFlags() {
@@ -110,7 +110,7 @@ public final class ModuleOpens implements Cloneable, Node {
* Gets the opened package name.
*
* @param constantPool the constant pool from the ClassFile.
- * @return the opened package name.
+ * @return The opened package name.
* @since 6.10.0
*/
public String getPackageName(final ConstantPool constantPool) {
diff --git a/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
b/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
index 8a091c63..601f4886 100644
--- a/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
+++ b/src/main/java/org/apache/bcel/classfile/ModuleRequires.java
@@ -101,7 +101,7 @@ public final class ModuleRequires implements Cloneable,
Node {
/**
* Gets the flags for this ModuleRequires.
*
- * @return the requiresFlags.
+ * @return The requiresFlags.
* @since 6.10.0
*/
public int getRequiresFlags() {
diff --git
a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
index 4cfb5bd1..1f736e9f 100644
--- a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java
@@ -38,7 +38,7 @@ public class ParameterAnnotationEntry implements Node {
* Creates parameter annotation entries from attributes.
*
* @param attributes the attributes.
- * @return the parameter annotation entries.
+ * @return The parameter annotation entries.
*/
public static ParameterAnnotationEntry[]
createParameterAnnotationEntries(final Attribute[] attributes) {
if (attributes == null) {
@@ -103,7 +103,7 @@ public class ParameterAnnotationEntry implements Node {
/**
* Gets the annotation entries.
*
- * @return the array of annotation entries in this annotation.
+ * @return The array of annotation entries in this annotation.
*/
public AnnotationEntry[] getAnnotationEntries() {
return annotationTable;
diff --git a/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
b/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
index bbbd9f72..28b3d04d 100644
--- a/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
+++ b/src/main/java/org/apache/bcel/classfile/ParameterAnnotations.java
@@ -104,7 +104,7 @@ public abstract class ParameterAnnotations extends
Attribute implements Iterable
/**
* Gets the parameter annotation entries.
*
- * @return the array of parameter annotation entries in this parameter
annotation.
+ * @return The array of parameter annotation entries in this parameter
annotation.
*/
public ParameterAnnotationEntry[] getParameterAnnotationEntries() {
return parameterAnnotationTable;
@@ -113,7 +113,7 @@ public abstract class ParameterAnnotations extends
Attribute implements Iterable
/**
* Gets the parameter annotation table.
*
- * @return the parameter annotation entry table.
+ * @return The parameter annotation entry table.
*/
public final ParameterAnnotationEntry[] getParameterAnnotationTable() {
return parameterAnnotationTable;
diff --git a/src/main/java/org/apache/bcel/classfile/Signature.java
b/src/main/java/org/apache/bcel/classfile/Signature.java
index fdb8490c..ddca1fb6 100644
--- a/src/main/java/org/apache/bcel/classfile/Signature.java
+++ b/src/main/java/org/apache/bcel/classfile/Signature.java
@@ -163,7 +163,7 @@ public final class Signature extends Attribute {
* Translates a signature string.
*
* @param s the signature string.
- * @return the translated signature.
+ * @return The translated signature.
*/
public static String translate(final String s) {
// System.out.println("Sig:" + s);
diff --git a/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
b/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
index 693274f3..6f4248cd 100644
--- a/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/SimpleElementValue.java
@@ -76,7 +76,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the boolean value.
*
- * @return the boolean value.
+ * @return The boolean value.
*/
public boolean getValueBoolean() {
if (super.getType() != PRIMITIVE_BOOLEAN) {
@@ -89,7 +89,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the byte value.
*
- * @return the byte value.
+ * @return The byte value.
*/
public byte getValueByte() {
if (super.getType() != PRIMITIVE_BYTE) {
@@ -101,7 +101,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the char value.
*
- * @return the char value.
+ * @return The char value.
*/
public char getValueChar() {
if (super.getType() != PRIMITIVE_CHAR) {
@@ -113,7 +113,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the double value.
*
- * @return the double value.
+ * @return The double value.
*/
public double getValueDouble() {
if (super.getType() != PRIMITIVE_DOUBLE) {
@@ -126,7 +126,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the float value.
*
- * @return the float value.
+ * @return The float value.
*/
public float getValueFloat() {
if (super.getType() != PRIMITIVE_FLOAT) {
@@ -139,7 +139,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the int value.
*
- * @return the int value.
+ * @return The int value.
*/
public int getValueInt() {
if (super.getType() != PRIMITIVE_INT) {
@@ -151,7 +151,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the long value.
*
- * @return the long value.
+ * @return The long value.
*/
public long getValueLong() {
if (super.getType() != PRIMITIVE_LONG) {
@@ -164,7 +164,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the short value.
*
- * @return the short value.
+ * @return The short value.
*/
public short getValueShort() {
if (super.getType() != PRIMITIVE_SHORT) {
@@ -177,7 +177,7 @@ public class SimpleElementValue extends ElementValue {
/**
* Gets the string value.
*
- * @return the string value.
+ * @return The string value.
*/
public String getValueString() {
if (super.getType() != STRING) {
diff --git a/src/main/java/org/apache/bcel/classfile/StackMap.java
b/src/main/java/org/apache/bcel/classfile/StackMap.java
index a070250c..4e1439cc 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMap.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMap.java
@@ -122,7 +122,7 @@ public final class StackMap extends Attribute {
/**
* Gets the map length.
*
- * @return the map length.
+ * @return The map length.
*/
public int getMapLength() {
return table.length;
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
index 5511b778..812ec827 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
@@ -215,7 +215,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the byte code offset.
*
- * @return the byte code offset.
+ * @return The byte code offset.
*/
public int getByteCodeOffset() {
return byteCodeOffset;
@@ -233,7 +233,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the frame type.
*
- * @return the frame type.
+ * @return The frame type.
*/
public int getFrameType() {
return frameType;
@@ -278,7 +278,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the number of locals.
*
- * @return the number of locals.
+ * @return The number of locals.
*/
public int getNumberOfLocals() {
return typesOfLocals.length;
@@ -287,7 +287,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the number of stack items.
*
- * @return the number of stack items.
+ * @return The number of stack items.
*/
public int getNumberOfStackItems() {
return typesOfStackItems.length;
@@ -296,7 +296,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the types of locals.
*
- * @return the types of locals.
+ * @return The types of locals.
*/
public StackMapType[] getTypesOfLocals() {
return typesOfLocals;
@@ -305,7 +305,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* Gets the types of stack items.
*
- * @return the types of stack items.
+ * @return The types of stack items.
*/
public StackMapType[] getTypesOfStackItems() {
return typesOfStackItems;
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapType.java
b/src/main/java/org/apache/bcel/classfile/StackMapType.java
index 59ee0f5a..8ec31e5e 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapType.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapType.java
@@ -119,7 +119,7 @@ public final class StackMapType implements Node, Cloneable {
/**
* Gets the class name of this StackMapType from the constant pool at
index position.
*
- * @return the fully qualified name of the class for this StackMapType.
+ * @return The fully qualified name of the class for this StackMapType.
* @since 6.8.0
*/
public String getClassName() {
@@ -148,7 +148,7 @@ public final class StackMapType implements Node, Cloneable {
/**
* Gets the type.
*
- * @return the type.
+ * @return The type.
*/
public byte getType() {
return type;
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java
b/src/main/java/org/apache/bcel/classfile/Utility.java
index 43e714b7..3a8f7515 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -605,7 +605,7 @@ public abstract class Utility {
* Escape all occurrences of newline chars '\n', quotes \", etc.
*
* @param label the string to convert.
- * @return the converted string.
+ * @return The converted string.
*/
public static String convertString(final String label) {
final char[] ch = label.toCharArray();
@@ -670,7 +670,7 @@ public abstract class Utility {
*
* @param s the string to convert.
* @param uncompress use gzip to uncompress the stream of bytes.
- * @return the decoded byte array.
+ * @return The decoded byte array.
* @throws IOException if there's a gzip exception.
*/
public static byte[] decode(final String s, final boolean uncompress)
throws IOException {
@@ -711,7 +711,7 @@ public abstract class Utility {
*
* @param bytes the byte array to convert.
* @param compress use gzip to minimize string.
- * @return the encoded string.
+ * @return The encoded string.
* @throws IOException if there's a gzip exception.
*/
public static String encode(byte[] bytes, final boolean compress) throws
IOException {
@@ -1077,7 +1077,7 @@ public abstract class Utility {
* Prints an array to a string.
*
* @param obj the array to print.
- * @return the string representation.
+ * @return The string representation.
*/
public static String printArray(final Object[] obj) {
return printArray(obj, true);
@@ -1088,7 +1088,7 @@ public abstract class Utility {
*
* @param obj the array to print.
* @param braces whether to include braces.
- * @return the string representation.
+ * @return The string representation.
*/
public static String printArray(final Object[] obj, final boolean braces) {
return printArray(obj, braces, false);
@@ -1100,7 +1100,7 @@ public abstract class Utility {
* @param obj the array to print.
* @param braces whether to include braces.
* @param quote whether to quote elements.
- * @return the string representation.
+ * @return The string representation.
*/
public static String printArray(final Object[] obj, final boolean braces,
final boolean quote) {
if (obj == null) {
@@ -1180,7 +1180,7 @@ public abstract class Utility {
* Map opcode names to opcode numbers. E.g., return Constants.ALOAD for
"aload".
*
* @param name The opcode name.
- * @return the value.
+ * @return The value.
*/
public static short searchOpcode(final String name) {
final String lcName = StringUtils.toRootLowerCase(name);
diff --git
a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
index 2306e992..3bd1258d 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
@@ -80,7 +80,7 @@ public class AnnotationElementValueGen extends
ElementValueGen {
/**
* Gets the annotation.
*
- * @return the annotation.
+ * @return The annotation.
*/
public AnnotationEntryGen getAnnotation() {
return a;
diff --git a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
index 3cea40ac..7c41b982 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
@@ -207,7 +207,7 @@ public class AnnotationEntryGen {
* @param dis the data input stream.
* @param cpool the constant pool generator.
* @param b whether the annotation is runtime visible.
- * @return the annotation entry generator.
+ * @return The annotation entry generator.
* @throws IOException if an I/O error occurs.
*/
public static AnnotationEntryGen read(final DataInput dis, final
ConstantPoolGen cpool, final boolean b) throws IOException {
@@ -316,7 +316,7 @@ public class AnnotationEntryGen {
/**
* Gets the type index.
*
- * @return the type index.
+ * @return The type index.
*/
public int getTypeIndex() {
return typeIndex;
@@ -325,7 +325,7 @@ public class AnnotationEntryGen {
/**
* Gets the type name.
*
- * @return the type name.
+ * @return The type name.
*/
public final String getTypeName() {
return getTypeSignature(); // BCELBUG: Should I use this instead?
@@ -335,7 +335,7 @@ public class AnnotationEntryGen {
/**
* Gets the type signature.
*
- * @return the type signature.
+ * @return The type signature.
*/
public final String getTypeSignature() {
// ConstantClass c = (ConstantClass) cpool.getConstant(typeIndex);
diff --git a/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
index 27496f18..3a243970 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayElementValueGen.java
@@ -115,7 +115,7 @@ public class ArrayElementValueGen extends ElementValueGen {
/**
* Gets the element values.
*
- * @return the element values.
+ * @return The element values.
*/
public List<ElementValueGen> getElementValues() {
return evalues;
@@ -124,7 +124,7 @@ public class ArrayElementValueGen extends ElementValueGen {
/**
* Gets the element values size.
*
- * @return the element values size.
+ * @return The element values size.
*/
public int getElementValuesSize() {
return evalues.size();
diff --git a/src/main/java/org/apache/bcel/generic/BasicType.java
b/src/main/java/org/apache/bcel/generic/BasicType.java
index 990ca6e1..847d8678 100644
--- a/src/main/java/org/apache/bcel/generic/BasicType.java
+++ b/src/main/java/org/apache/bcel/generic/BasicType.java
@@ -29,7 +29,7 @@ public final class BasicType extends Type {
* Gets the BasicType for the given type constant.
*
* @param type the type constant.
- * @return the BasicType.
+ * @return The BasicType.
* @since 6.0
*/
// @since 6.0 no longer final
diff --git a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
index 18adac97..4c999cb8 100644
--- a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
@@ -123,7 +123,7 @@ public abstract class BranchInstruction extends Instruction
implements Instructi
/**
* Gets the position.
*
- * @return the position.
+ * @return The position.
* @since 6.0
*/
protected int getPosition() {
@@ -142,7 +142,7 @@ public abstract class BranchInstruction extends Instruction
implements Instructi
/**
* Gets the offset to this instruction's target.
*
- * @return the offset to this instruction's target.
+ * @return The offset to this instruction's target.
*/
protected int getTargetOffset() {
return getTargetOffset(target);
@@ -152,7 +152,7 @@ public abstract class BranchInstruction extends Instruction
implements Instructi
* Gets the offset to target relative to this instruction.
*
* @param target branch target.
- * @return the offset to 'target' relative to this instruction.
+ * @return The offset to 'target' relative to this instruction.
*/
protected int getTargetOffset(final InstructionHandle target) {
if (target == null) {
diff --git a/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
index 2adf8c44..c152ac14 100644
--- a/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassElementValueGen.java
@@ -85,7 +85,7 @@ public class ClassElementValueGen extends ElementValueGen {
/**
* Gets the class string.
*
- * @return the class string.
+ * @return The class string.
*/
public String getClassString() {
final ConstantUtf8 cu8 = (ConstantUtf8)
getConstantPool().getConstant(idx);
@@ -109,7 +109,7 @@ public class ClassElementValueGen extends ElementValueGen {
/**
* Gets the index.
*
- * @return the index.
+ * @return The index.
*/
public int getIndex() {
return idx;
diff --git a/src/main/java/org/apache/bcel/generic/ClassGen.java
b/src/main/java/org/apache/bcel/generic/ClassGen.java
index d223a421..b89a2d30 100644
--- a/src/main/java/org/apache/bcel/generic/ClassGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassGen.java
@@ -319,7 +319,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the annotation entries.
*
- * @return the annotation entries.
+ * @return The annotation entries.
*/
// J5TODO: Should we make calling unpackAnnotations() lazy and put it in
here?
public AnnotationEntryGen[] getAnnotationEntries() {
@@ -329,7 +329,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the attributes.
*
- * @return the attributes.
+ * @return The attributes.
*/
public Attribute[] getAttributes() {
return attributeList.toArray(Attribute.EMPTY_ARRAY);
@@ -338,7 +338,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the class name.
*
- * @return the class name.
+ * @return The class name.
*/
public String getClassName() {
return className;
@@ -347,7 +347,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the class name index.
*
- * @return the class name index.
+ * @return The class name index.
*/
public int getClassNameIndex() {
return classNameIndex;
@@ -356,7 +356,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the constant pool.
*
- * @return the constant pool.
+ * @return The constant pool.
*/
public ConstantPoolGen getConstantPool() {
return cp;
@@ -365,7 +365,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the fields.
*
- * @return the fields.
+ * @return The fields.
*/
public Field[] getFields() {
return fieldList.toArray(Field.EMPTY_ARRAY);
@@ -374,7 +374,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the file name.
*
- * @return the file name.
+ * @return The file name.
*/
public String getFileName() {
return fileName;
@@ -383,7 +383,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the interface names.
*
- * @return the interface names.
+ * @return The interface names.
*/
public String[] getInterfaceNames() {
return interfaceList.toArray(ArrayUtils.EMPTY_STRING_ARRAY);
@@ -392,7 +392,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the interfaces.
*
- * @return the interfaces.
+ * @return The interfaces.
*/
public int[] getInterfaces() {
final int size = interfaceList.size();
@@ -404,7 +404,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the (finally) built up Java class object.
*
- * @return the (finally) built up Java class object.
+ * @return The (finally) built up Java class object.
*/
public JavaClass getJavaClass() {
final int[] interfaces = getInterfaces();
@@ -439,7 +439,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
* Gets the method at the given position.
*
* @param pos the position.
- * @return the method at the given position.
+ * @return The method at the given position.
*/
public Method getMethodAt(final int pos) {
return methodList.get(pos);
@@ -448,7 +448,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the methods.
*
- * @return the methods.
+ * @return The methods.
*/
public Method[] getMethods() {
return methodList.toArray(Method.EMPTY_ARRAY);
@@ -466,7 +466,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the superclass name.
*
- * @return the superclass name.
+ * @return The superclass name.
*/
public String getSuperclassName() {
return superClassName;
@@ -475,7 +475,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
/**
* Gets the superclass name index.
*
- * @return the superclass name index.
+ * @return The superclass name index.
*/
public int getSuperclassNameIndex() {
return superclassNameIndex;
diff --git a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
index 3e730a72..7444bf13 100644
--- a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
+++ b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
@@ -76,7 +76,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
/**
* Gets the type of the Exception to catch, 'null' for ANY.
*
- * @return the type of the Exception to catch, 'null' for ANY.
+ * @return The type of the Exception to catch, 'null' for ANY.
*/
public ObjectType getCatchType() {
return catchType;
@@ -89,7 +89,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
* has been called for the instruction list.
*
* @param cp constant pool.
- * @return the CodeException object.
+ * @return The CodeException object.
*/
public CodeException getCodeException(final ConstantPoolGen cp) {
return new CodeException(startPc.getPosition(), endPc.getPosition() +
endPc.getInstruction().getLength(), handlerPc.getPosition(),
diff --git a/src/main/java/org/apache/bcel/generic/CompoundInstruction.java
b/src/main/java/org/apache/bcel/generic/CompoundInstruction.java
index f5421a89..8ca59881 100644
--- a/src/main/java/org/apache/bcel/generic/CompoundInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/CompoundInstruction.java
@@ -34,7 +34,7 @@ public interface CompoundInstruction {
/**
* Gets the instruction list.
*
- * @return the instruction list.
+ * @return The instruction list.
*/
InstructionList getInstructionList();
}
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
index a2cf1980..7813aa5e 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
@@ -30,7 +30,7 @@ public interface ConstantPushInstruction extends
PushInstruction, TypedInstructi
/**
* Gets the value to push onto the stack.
*
- * @return the value to push onto the stack.
+ * @return The value to push onto the stack.
*/
Number getValue();
}
diff --git a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
index 1d6676bc..dd3e438f 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
@@ -114,7 +114,7 @@ public abstract class ElementValueGen {
*
* @param dis the data input stream.
* @param cpGen the constant pool.
- * @return the element value read.
+ * @return The element value read.
* @throws IOException if an I/O error occurs.
*/
public static ElementValueGen readElementValue(final DataInput dis, final
ConstantPoolGen cpGen) throws IOException {
@@ -193,7 +193,7 @@ public abstract class ElementValueGen {
/**
* Gets the constant pool.
*
- * @return the constant pool.
+ * @return The constant pool.
*/
protected ConstantPoolGen getConstantPool() {
return cpGen;
@@ -209,7 +209,7 @@ public abstract class ElementValueGen {
/**
* Gets the element value type.
*
- * @return the element value type.
+ * @return The element value type.
*/
public int getElementValueType() {
return type;
diff --git a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
index 58e46745..d234c05e 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
@@ -112,7 +112,7 @@ public class ElementValuePairGen {
/**
* Gets the name index.
*
- * @return the name index.
+ * @return The name index.
*/
public int getNameIndex() {
return nameIdx;
@@ -121,7 +121,7 @@ public class ElementValuePairGen {
/**
* Gets the name string.
*
- * @return the name string.
+ * @return The name string.
*/
public final String getNameString() {
// ConstantString cu8 = (ConstantString)
constantPoolGen.getConstant(nameIdx);
@@ -131,7 +131,7 @@ public class ElementValuePairGen {
/**
* Gets the value.
*
- * @return the element value.
+ * @return The element value.
*/
public final ElementValueGen getValue() {
return value;
diff --git a/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
b/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
index 0547db12..08f59358 100644
--- a/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/EnumElementValueGen.java
@@ -105,7 +105,7 @@ public class EnumElementValueGen extends ElementValueGen {
/**
* Gets the enum type string.
*
- * @return the enum type string.
+ * @return The enum type string.
*/
public String getEnumTypeString() {
// Constant cc = getConstantPool().getConstant(typeIdx);
@@ -120,7 +120,7 @@ public class EnumElementValueGen extends ElementValueGen {
/**
* Gets the enum value string.
*
- * @return the enum value string.
+ * @return The enum value string.
*/
public String getEnumValueString() {
return ((ConstantUtf8)
getConstantPool().getConstant(valueIdx)).getBytes();
@@ -133,7 +133,7 @@ public class EnumElementValueGen extends ElementValueGen {
/**
* Gets the type index.
*
- * @return the type index.
+ * @return The type index.
*/
public int getTypeIndex() {
return typeIdx;
@@ -142,7 +142,7 @@ public class EnumElementValueGen extends ElementValueGen {
/**
* Gets the value index.
*
- * @return the value index.
+ * @return The value index.
*/
public int getValueIndex() {
return valueIdx;
diff --git a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
index 635fd066..ede2f814 100644
--- a/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
+++ b/src/main/java/org/apache/bcel/generic/ExceptionThrower.java
@@ -34,7 +34,7 @@ public interface ExceptionThrower {
/**
* Gets the exceptions that may be thrown by this instruction.
*
- * @return the exceptions that may be thrown by this instruction.
+ * @return The exceptions that may be thrown by this instruction.
*/
Class<?>[] getExceptions();
}
diff --git a/src/main/java/org/apache/bcel/generic/FieldGen.java
b/src/main/java/org/apache/bcel/generic/FieldGen.java
index 6c9401d9..5f9951bc 100644
--- a/src/main/java/org/apache/bcel/generic/FieldGen.java
+++ b/src/main/java/org/apache/bcel/generic/FieldGen.java
@@ -197,7 +197,7 @@ public class FieldGen extends FieldGenOrMethodGen {
/**
* Gets field object after having set up all necessary values.
*
- * @return the field object.
+ * @return The field object.
*/
public Field getField() {
final String signature = getSignature();
@@ -215,7 +215,7 @@ public class FieldGen extends FieldGenOrMethodGen {
/**
* Gets the initial value.
*
- * @return the initial value.
+ * @return The initial value.
*/
public String getInitValue() {
return Objects.toString(value, null);
diff --git a/src/main/java/org/apache/bcel/generic/FieldGenOrMethodGen.java
b/src/main/java/org/apache/bcel/generic/FieldGenOrMethodGen.java
index 8f221d9f..d464fcaf 100644
--- a/src/main/java/org/apache/bcel/generic/FieldGenOrMethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/FieldGenOrMethodGen.java
@@ -131,7 +131,7 @@ public abstract class FieldGenOrMethodGen extends
AccessFlags implements NamedAn
/**
* Gets the constant pool.
*
- * @return the constant pool.
+ * @return The constant pool.
*/
public ConstantPoolGen getConstantPool() {
return cp;
diff --git a/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java
b/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java
index d8798cdc..6657b3a8 100644
--- a/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java
+++ b/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java
@@ -101,7 +101,7 @@ public final class INVOKEINTERFACE extends
InvokeInstruction {
/**
* The <strong>count</strong> argument according to the Java Language
Specification, Second Edition.
*
- * @return the count argument.
+ * @return The count argument.
*/
public int getCount() {
return nargs;
diff --git a/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
b/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
index f15eb576..0fea7fd0 100644
--- a/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/IndexedInstruction.java
@@ -26,7 +26,7 @@ public interface IndexedInstruction {
/**
* Gets the index.
*
- * @return the index.
+ * @return The index.
*/
int getIndex();
diff --git a/src/main/java/org/apache/bcel/generic/Instruction.java
b/src/main/java/org/apache/bcel/generic/Instruction.java
index fc0d3705..300bb784 100644
--- a/src/main/java/org/apache/bcel/generic/Instruction.java
+++ b/src/main/java/org/apache/bcel/generic/Instruction.java
@@ -535,7 +535,7 @@ public abstract class Instruction implements Cloneable {
/**
* Gets the hashCode of this object.
*
- * @return the hashCode.
+ * @return The hashCode.
* @since 6.0
*/
@Override
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConst.java
b/src/main/java/org/apache/bcel/generic/InstructionConst.java
index db299315..314d6de7 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConst.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConst.java
@@ -520,7 +520,7 @@ public final class InstructionConst {
* Gets the Instruction.
*
* @param index the index, for example {@link Const#RETURN}.
- * @return the entry from the private INSTRUCTIONS table.
+ * @return The entry from the private INSTRUCTIONS table.
*/
public static Instruction getInstruction(final int index) {
return INSTRUCTIONS[index];
diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
index 37fc677c..ca59cce5 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
@@ -72,7 +72,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates an array load instruction for the given type.
*
* @param type type of elements of array, that is, array.getElementType().
- * @return the array load instruction.
+ * @return The array load instruction.
*/
public static ArrayInstruction createArrayLoad(final Type type) {
switch (type.getType()) {
@@ -103,7 +103,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates an array store instruction for the given type.
*
* @param type type of elements of array, that is, array.getElementType().
- * @return the array store instruction.
+ * @return The array store instruction.
*/
public static ArrayInstruction createArrayStore(final Type type) {
switch (type.getType()) {
@@ -243,7 +243,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param op operation, such as "+", "*", "<<", etc.
* @param type the operand type.
- * @return the binary arithmetic instruction.
+ * @return The binary arithmetic instruction.
*/
public static ArithmeticInstruction createBinaryOperation(final String op,
final Type type) {
final char first = op.charAt(0);
@@ -270,7 +270,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param opcode the branch opcode.
* @param target the target instruction handle.
- * @return the branch instruction.
+ * @return The branch instruction.
*/
public static BranchInstruction createBranchInstruction(final short
opcode, final InstructionHandle target) {
switch (opcode) {
@@ -323,7 +323,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a DUP instruction.
*
* @param size size of operand, either 1 (int, for example) or 2 (double).
- * @return the DUP instruction.
+ * @return The DUP instruction.
*/
public static StackInstruction createDup(final int size) {
return size == 2 ? InstructionConst.DUP2 : InstructionConst.DUP;
@@ -333,7 +333,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a DUP_X1 instruction.
*
* @param size size of operand, either 1 (int, for example) or 2 (double).
- * @return the DUP instruction.
+ * @return The DUP instruction.
*/
public static StackInstruction createDup_1(final int size) {
return size == 2 ? InstructionConst.DUP2_X1 : InstructionConst.DUP_X1;
@@ -343,7 +343,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a DUP_X2 instruction.
*
* @param size size of operand, either 1 (int, for example) or 2 (double).
- * @return the DUP instruction.
+ * @return The DUP instruction.
*/
public static StackInstruction createDup_2(final int size) {
return size == 2 ? InstructionConst.DUP2_X2 : InstructionConst.DUP_X2;
@@ -354,7 +354,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param type the variable type.
* @param index index of local variable.
- * @return the load instruction.
+ * @return The load instruction.
*/
public static LocalVariableInstruction createLoad(final Type type, final
int index) {
switch (type.getType()) {
@@ -382,7 +382,7 @@ public class InstructionFactory implements
InstructionConstants {
* Create "null" value for reference types, 0 for basic types like int.
*
* @param type the type.
- * @return the null or zero instruction.
+ * @return The null or zero instruction.
*/
public static Instruction createNull(final Type type) {
switch (type.getType()) {
@@ -412,7 +412,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a pop instruction.
*
* @param size size of operand, either 1 (int, for example) or 2 (double).
- * @return the pop instruction.
+ * @return The pop instruction.
*/
public static StackInstruction createPop(final int size) {
return size == 2 ? InstructionConst.POP2 : InstructionConst.POP;
@@ -422,7 +422,7 @@ public class InstructionFactory implements
InstructionConstants {
* Create typed return.
*
* @param type the return type.
- * @return the return instruction.
+ * @return The return instruction.
*/
public static ReturnInstruction createReturn(final Type type) {
switch (type.getType()) {
@@ -453,7 +453,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param type the variable type.
* @param index index of local variable.
- * @return the store instruction.
+ * @return The store instruction.
*/
public static LocalVariableInstruction createStore(final Type type, final
int index) {
switch (type.getType()) {
@@ -535,7 +535,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates an append instruction for the given type.
*
* @param type the type to append.
- * @return the append instruction.
+ * @return The append instruction.
*/
public Instruction createAppend(final Type type) {
final byte t = type.getType();
@@ -566,7 +566,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param srcType the source type.
* @param destType the destination type.
- * @return the conversion instruction.
+ * @return The conversion instruction.
*/
public Instruction createCast(final Type srcType, final Type destType) {
if (srcType instanceof BasicType && destType instanceof BasicType) {
@@ -597,7 +597,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a CHECKCAST instruction.
*
* @param t the reference type.
- * @return the CHECKCAST instruction.
+ * @return The CHECKCAST instruction.
*/
public CHECKCAST createCheckCast(final ReferenceType t) {
if (t instanceof ArrayType) {
@@ -610,7 +610,7 @@ public class InstructionFactory implements
InstructionConstants {
* Uses PUSH to push a constant value onto the stack.
*
* @param value must be of type Number, Boolean, Character or String.
- * @return the instruction.
+ * @return The instruction.
*/
public Instruction createConstant(final Object value) {
final PUSH push;
@@ -661,7 +661,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param className the class name.
* @param name the field name.
* @param t the field type.
- * @return the GETFIELD instruction.
+ * @return The GETFIELD instruction.
*/
public GETFIELD createGetField(final String className, final String name,
final Type t) {
return new GETFIELD(cp.addFieldref(className, name, t.getSignature()));
@@ -673,7 +673,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param className the class name.
* @param name the field name.
* @param t the field type.
- * @return the GETSTATIC instruction.
+ * @return The GETSTATIC instruction.
*/
public GETSTATIC createGetStatic(final String className, final String
name, final Type t) {
return new GETSTATIC(cp.addFieldref(className, name,
t.getSignature()));
@@ -683,7 +683,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates an INSTANCEOF instruction.
*
* @param t the reference type.
- * @return the INSTANCEOF instruction.
+ * @return The INSTANCEOF instruction.
*/
public INSTANCEOF createInstanceOf(final ReferenceType t) {
if (t instanceof ArrayType) {
@@ -704,7 +704,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param retType return type of method.
* @param argTypes argument types of method.
* @param kind how to invoke, that is, INVOKEINTERFACE, INVOKESTATIC,
INVOKEVIRTUAL, or INVOKESPECIAL.
- * @return the invoke instruction.
+ * @return The invoke instruction.
* @see Const
*/
public InvokeInstruction createInvoke(final String className, final String
name, final Type retType, final Type[] argTypes, final short kind) {
@@ -763,7 +763,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a NEW instruction.
*
* @param t the object type.
- * @return the NEW instruction.
+ * @return The NEW instruction.
*/
public NEW createNew(final ObjectType t) {
return new NEW(cp.addClass(t));
@@ -773,7 +773,7 @@ public class InstructionFactory implements
InstructionConstants {
* Creates a NEW instruction.
*
* @param s the class name.
- * @return the NEW instruction.
+ * @return The NEW instruction.
*/
public NEW createNew(final String s) {
return createNew(ObjectType.getInstance(s));
@@ -809,7 +809,7 @@ public class InstructionFactory implements
InstructionConstants {
* Create a call to the most popular System.out.println() method.
*
* @param s the string to print.
- * @return the instruction list.
+ * @return The instruction list.
*/
public InstructionList createPrintln(final String s) {
final InstructionList il = new InstructionList();
@@ -826,7 +826,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param className the class name.
* @param name the field name.
* @param t the field type.
- * @return the PUTFIELD instruction.
+ * @return The PUTFIELD instruction.
*/
public PUTFIELD createPutField(final String className, final String name,
final Type t) {
return new PUTFIELD(cp.addFieldref(className, name, t.getSignature()));
@@ -838,7 +838,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param className the class name.
* @param name the field name.
* @param t the field type.
- * @return the PUTSTATIC instruction.
+ * @return The PUTSTATIC instruction.
*/
public PUTSTATIC createPutStatic(final String className, final String
name, final Type t) {
return new PUTSTATIC(cp.addFieldref(className, name,
t.getSignature()));
@@ -847,7 +847,7 @@ public class InstructionFactory implements
InstructionConstants {
/**
* Gets the class generator.
*
- * @return the class generator.
+ * @return The class generator.
*/
public ClassGen getClassGen() {
return cg;
@@ -856,7 +856,7 @@ public class InstructionFactory implements
InstructionConstants {
/**
* Gets the constant pool generator.
*
- * @return the constant pool generator.
+ * @return The constant pool generator.
*/
public ConstantPoolGen getConstantPool() {
return cp;
diff --git a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
index 8c517351..74d6252d 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
@@ -143,7 +143,7 @@ public class InstructionHandle {
* Gets attribute of an instruction handle.
*
* @param key the key object to store/retrieve the attribute.
- * @return the attribute value.
+ * @return The attribute value.
*/
public Object getAttribute(final Object key) {
return attributes != null ? attributes.get(key) : null;
@@ -164,7 +164,7 @@ public class InstructionHandle {
/**
* Gets the instruction.
*
- * @return the instruction.
+ * @return The instruction.
*/
public final Instruction getInstruction() {
return instruction;
@@ -173,7 +173,7 @@ public class InstructionHandle {
/**
* Gets the next instruction handle.
*
- * @return the next instruction handle.
+ * @return The next instruction handle.
*/
public final InstructionHandle getNext() {
return next;
@@ -182,7 +182,7 @@ public class InstructionHandle {
/**
* Gets the position.
*
- * @return the position, the byte code offset of the contained
instruction. This is accurate only after
+ * @return The position, the byte code offset of the contained
instruction. This is accurate only after
* InstructionList.setPositions() has been called.
*/
public int getPosition() {
@@ -192,7 +192,7 @@ public class InstructionHandle {
/**
* Gets the previous instruction handle.
*
- * @return the previous instruction handle.
+ * @return The previous instruction handle.
*/
public final InstructionHandle getPrev() {
return prev;
@@ -274,7 +274,7 @@ public class InstructionHandle {
* Sets the next instruction handle.
*
* @param next the next to set.
- * @return the next instruction handle.
+ * @return The next instruction handle.
* @since 6.0
*/
final InstructionHandle setNext(final InstructionHandle next) {
@@ -295,7 +295,7 @@ public class InstructionHandle {
* Sets the previous instruction handle.
*
* @param prev the prev to set.
- * @return the previous instruction handle.
+ * @return The previous instruction handle.
* @since 6.0
*/
final InstructionHandle setPrev(final InstructionHandle prev) {
@@ -311,7 +311,7 @@ public class InstructionHandle {
* cached instruction, whereas other BH methods may affect the cache and
the replacement instruction.
*
* @param i the replacement instruction.
- * @return the old instruction.
+ * @return The old instruction.
*/
// See BCEL-273
// TODO remove this method in any redesign of BCEL
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 2e3b23a1..3056602a 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -585,7 +585,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
/**
* When everything is finished, use this method to convert the instruction
list into an array of bytes.
*
- * @return the byte code ready to be dumped.
+ * @return The byte code ready to be dumped.
*/
public byte[] getByteCode() {
// Update position indices of instructions
diff --git a/src/main/java/org/apache/bcel/generic/LDC.java
b/src/main/java/org/apache/bcel/generic/LDC.java
index 2d916b50..fe9a0aae 100644
--- a/src/main/java/org/apache/bcel/generic/LDC.java
+++ b/src/main/java/org/apache/bcel/generic/LDC.java
@@ -107,7 +107,7 @@ public class LDC extends CPInstruction implements
PushInstruction, ExceptionThro
* Gets the constant value from the constant pool.
*
* @param cpg constant pool generator.
- * @return the constant value.
+ * @return The constant value.
*/
public Object getValue(final ConstantPoolGen cpg) {
org.apache.bcel.classfile.Constant c =
cpg.getConstantPool().getConstant(super.getIndex());
diff --git a/src/main/java/org/apache/bcel/generic/LDC2_W.java
b/src/main/java/org/apache/bcel/generic/LDC2_W.java
index 3075abc7..ef0902e1 100644
--- a/src/main/java/org/apache/bcel/generic/LDC2_W.java
+++ b/src/main/java/org/apache/bcel/generic/LDC2_W.java
@@ -73,7 +73,7 @@ public class LDC2_W extends CPInstruction implements
PushInstruction {
* Gets the constant value from the constant pool.
*
* @param cpg constant pool generator.
- * @return the constant value as a Number.
+ * @return The constant value as a Number.
*/
public Number getValue(final ConstantPoolGen cpg) {
final org.apache.bcel.classfile.Constant c =
cpg.getConstantPool().getConstant(super.getIndex());
diff --git a/src/main/java/org/apache/bcel/generic/LineNumberGen.java
b/src/main/java/org/apache/bcel/generic/LineNumberGen.java
index 76e6e3ed..41f704a8 100644
--- a/src/main/java/org/apache/bcel/generic/LineNumberGen.java
+++ b/src/main/java/org/apache/bcel/generic/LineNumberGen.java
@@ -67,7 +67,7 @@ public class LineNumberGen implements InstructionTargeter,
Cloneable {
/**
* Gets the instruction handle.
*
- * @return the instruction handle.
+ * @return The instruction handle.
*/
public InstructionHandle getInstruction() {
return ih;
@@ -79,7 +79,7 @@ public class LineNumberGen implements InstructionTargeter,
Cloneable {
* This relies on that the instruction list has already been dumped to
byte code or that the 'setPositions' methods
* has been called for the instruction list.
*
- * @return the line number attribute.
+ * @return The line number attribute.
*/
public LineNumber getLineNumber() {
return new LineNumber(ih.getPosition(), srcLine);
@@ -88,7 +88,7 @@ public class LineNumberGen implements InstructionTargeter,
Cloneable {
/**
* Gets the source line number.
*
- * @return the source line number.
+ * @return The source line number.
*/
public int getSourceLine() {
return srcLine;
diff --git a/src/main/java/org/apache/bcel/generic/LoadClass.java
b/src/main/java/org/apache/bcel/generic/LoadClass.java
index 880e944e..13930be6 100644
--- a/src/main/java/org/apache/bcel/generic/LoadClass.java
+++ b/src/main/java/org/apache/bcel/generic/LoadClass.java
@@ -38,7 +38,7 @@ public interface LoadClass {
* {@code int[][]}.
*
* @param cpg A ConstantPoolGen.
- * @return the type associated with this instruction.
+ * @return The type associated with this instruction.
* @see #getLoadClassType(ConstantPoolGen)
*/
Type getType(ConstantPoolGen cpg);
diff --git a/src/main/java/org/apache/bcel/generic/LocalVariableGen.java
b/src/main/java/org/apache/bcel/generic/LocalVariableGen.java
index d400938d..8dbed2f4 100644
--- a/src/main/java/org/apache/bcel/generic/LocalVariableGen.java
+++ b/src/main/java/org/apache/bcel/generic/LocalVariableGen.java
@@ -118,7 +118,7 @@ public class LocalVariableGen implements
InstructionTargeter, NamedAndTyped, Clo
/**
* Gets the end instruction handle.
*
- * @return the end instruction handle.
+ * @return The end instruction handle.
*/
public InstructionHandle getEnd() {
return end;
@@ -127,7 +127,7 @@ public class LocalVariableGen implements
InstructionTargeter, NamedAndTyped, Clo
/**
* Gets the index.
*
- * @return the index.
+ * @return The index.
*/
public int getIndex() {
return index;
@@ -153,7 +153,7 @@ public class LocalVariableGen implements
InstructionTargeter, NamedAndTyped, Clo
* instruction of the method. Hence the liveToEnd flag to differentiate
between these two cases.
*
* @param cp constant pool.
- * @return the local variable.
+ * @return The local variable.
*/
public LocalVariable getLocalVariable(final ConstantPoolGen cp) {
int startPc = 0;
@@ -178,7 +178,7 @@ public class LocalVariableGen implements
InstructionTargeter, NamedAndTyped, Clo
/**
* Gets the original index.
*
- * @return the original index.
+ * @return The original index.
*/
public int getOrigIndex() {
return origIndex;
@@ -187,7 +187,7 @@ public class LocalVariableGen implements
InstructionTargeter, NamedAndTyped, Clo
/**
* Gets the start instruction handle.
*
- * @return the start instruction handle.
+ * @return The start instruction handle.
*/
public InstructionHandle getStart() {
return start;
diff --git a/src/main/java/org/apache/bcel/generic/MethodGen.java
b/src/main/java/org/apache/bcel/generic/MethodGen.java
index 44859475..2f8dc2b8 100644
--- a/src/main/java/org/apache/bcel/generic/MethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/MethodGen.java
@@ -685,7 +685,7 @@ public class MethodGen extends FieldGenOrMethodGen {
* Gets the argument name at the specified index.
*
* @param i the argument index.
- * @return the argument name.
+ * @return The argument name.
*/
public String getArgumentName(final int i) {
return argNames[i];
@@ -704,7 +704,7 @@ public class MethodGen extends FieldGenOrMethodGen {
* Gets the argument type at the specified index.
*
* @param i the argument index.
- * @return the argument type.
+ * @return The argument type.
*/
public Type getArgumentType(final int i) {
return argTypes[i];
@@ -778,7 +778,7 @@ public class MethodGen extends FieldGenOrMethodGen {
/**
* Gets the instruction list.
*
- * @return the instruction list.
+ * @return The instruction list.
*/
public InstructionList getInstructionList() {
return il;
@@ -858,7 +858,7 @@ public class MethodGen extends FieldGenOrMethodGen {
/**
* Gets the maximum number of local variables.
*
- * @return the maximum number of local variables.
+ * @return The maximum number of local variables.
*/
public int getMaxLocals() {
return maxLocals;
@@ -867,7 +867,7 @@ public class MethodGen extends FieldGenOrMethodGen {
/**
* Gets the maximum stack size.
*
- * @return the maximum stack size.
+ * @return The maximum stack size.
*/
public int getMaxStack() {
return maxStack;
@@ -965,7 +965,7 @@ public class MethodGen extends FieldGenOrMethodGen {
/**
* Gets the return type.
*
- * @return the return type.
+ * @return The return type.
*/
public Type getReturnType() {
return getType();
diff --git
a/src/main/java/org/apache/bcel/generic/NameSignatureInstruction.java
b/src/main/java/org/apache/bcel/generic/NameSignatureInstruction.java
index f1a0349b..8198a715 100644
--- a/src/main/java/org/apache/bcel/generic/NameSignatureInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/NameSignatureInstruction.java
@@ -63,7 +63,7 @@ public abstract class NameSignatureInstruction extends
CPInstruction {
* Gets the name and type constant.
*
* @param cpg constant pool generator.
- * @return the name and type constant.
+ * @return The name and type constant.
*/
public ConstantNameAndType getNameAndType(final ConstantPoolGen cpg) {
final ConstantPool cp = cpg.getConstantPool();
diff --git a/src/main/java/org/apache/bcel/generic/NamedAndTyped.java
b/src/main/java/org/apache/bcel/generic/NamedAndTyped.java
index 166568fe..710ff76a 100644
--- a/src/main/java/org/apache/bcel/generic/NamedAndTyped.java
+++ b/src/main/java/org/apache/bcel/generic/NamedAndTyped.java
@@ -26,14 +26,14 @@ public interface NamedAndTyped {
/**
* Gets the name.
*
- * @return the name.
+ * @return The name.
*/
String getName();
/**
* Gets the type.
*
- * @return the type.
+ * @return The type.
*/
Type getType();
diff --git a/src/main/java/org/apache/bcel/generic/PUSH.java
b/src/main/java/org/apache/bcel/generic/PUSH.java
index 565a52fc..181cbfba 100644
--- a/src/main/java/org/apache/bcel/generic/PUSH.java
+++ b/src/main/java/org/apache/bcel/generic/PUSH.java
@@ -196,7 +196,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* Gets the instruction.
*
- * @return the instruction.
+ * @return The instruction.
*/
public Instruction getInstruction() {
return instruction;
diff --git a/src/main/java/org/apache/bcel/generic/ReferenceType.java
b/src/main/java/org/apache/bcel/generic/ReferenceType.java
index d4a3f22b..c45ed5a4 100644
--- a/src/main/java/org/apache/bcel/generic/ReferenceType.java
+++ b/src/main/java/org/apache/bcel/generic/ReferenceType.java
@@ -53,7 +53,7 @@ public abstract class ReferenceType extends Type {
* returned. See the JVM specification edition 2, "�4.9.2 The Bytecode
Verifier".
*
* @param t the other type.
- * @return the first common superclass.
+ * @return The first common superclass.
* @throws ClassNotFoundException on failure to find superclasses of this
type, or the type passed as a parameter.
* @deprecated Use getFirstCommonSuperclass(ReferenceType t) which has
slightly changed semantics.
*/
@@ -88,7 +88,7 @@ public abstract class ReferenceType extends Type {
* Bytecode Verifier".
*
* @param t the other type.
- * @return the first common superclass.
+ * @return The first common superclass.
* @throws ClassNotFoundException on failure to find superclasses of this
type, or the type passed as a parameter.
*/
public ReferenceType getFirstCommonSuperclass(final ReferenceType t)
throws ClassNotFoundException {
diff --git a/src/main/java/org/apache/bcel/generic/ReturnInstruction.java
b/src/main/java/org/apache/bcel/generic/ReturnInstruction.java
index 9f103360..bbc833b8 100644
--- a/src/main/java/org/apache/bcel/generic/ReturnInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/ReturnInstruction.java
@@ -49,7 +49,7 @@ public abstract class ReturnInstruction extends Instruction
implements Exception
/**
* Gets the type of the returned value.
*
- * @return the type.
+ * @return The type.
*/
public Type getType() {
final short opcode = super.getOpcode();
diff --git a/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
b/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
index f59ae63e..95fa8eb8 100644
--- a/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
+++ b/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
@@ -69,7 +69,7 @@ public class ReturnaddressType extends Type {
/**
* Gets the target of this ReturnaddressType.
*
- * @return the target of this ReturnaddressType.
+ * @return The target of this ReturnaddressType.
*/
public InstructionHandle getTarget() {
return returnTarget;
diff --git a/src/main/java/org/apache/bcel/generic/SWITCH.java
b/src/main/java/org/apache/bcel/generic/SWITCH.java
index 24d64b1f..f0f32060 100644
--- a/src/main/java/org/apache/bcel/generic/SWITCH.java
+++ b/src/main/java/org/apache/bcel/generic/SWITCH.java
@@ -135,7 +135,7 @@ public final class SWITCH implements CompoundInstruction {
/**
* Gets the instruction.
*
- * @return the instruction.
+ * @return The instruction.
*/
public Instruction getInstruction() {
return instruction;
diff --git a/src/main/java/org/apache/bcel/generic/Select.java
b/src/main/java/org/apache/bcel/generic/Select.java
index 5aaf7bb3..9cc84168 100644
--- a/src/main/java/org/apache/bcel/generic/Select.java
+++ b/src/main/java/org/apache/bcel/generic/Select.java
@@ -152,7 +152,7 @@ public abstract class Select extends BranchInstruction
implements VariableLength
}
/**
- * @return the fixed_length.
+ * @return The fixed_length.
* @since 6.0
*/
final int getFixedLength() {
@@ -185,7 +185,7 @@ public abstract class Select extends BranchInstruction
implements VariableLength
}
/**
- * @return the match_length.
+ * @return The match_length.
* @since 6.0
*/
final int getMatchLength() {
@@ -203,7 +203,7 @@ public abstract class Select extends BranchInstruction
implements VariableLength
/**
*
- * @return the padding.
+ * @return The padding.
* @since 6.0
*/
final int getPadding() {
diff --git a/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
b/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
index b48e290a..0881190c 100644
--- a/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/SimpleElementValueGen.java
@@ -244,7 +244,7 @@ public class SimpleElementValueGen extends ElementValueGen {
/**
* Gets the immutable variant.
*
- * @return the immutable variant.
+ * @return The immutable variant.
*/
@Override
public ElementValue getElementValue() {
@@ -254,7 +254,7 @@ public class SimpleElementValueGen extends ElementValueGen {
/**
* Gets the constant pool index.
*
- * @return the index.
+ * @return The index.
*/
public int getIndex() {
return idx;
@@ -263,7 +263,7 @@ public class SimpleElementValueGen extends ElementValueGen {
/**
* Gets the int value.
*
- * @return the int value.
+ * @return The int value.
*/
public int getValueInt() {
if (super.getElementValueType() != PRIMITIVE_INT) {
@@ -276,7 +276,7 @@ public class SimpleElementValueGen extends ElementValueGen {
/**
* Gets the string value.
*
- * @return the string value.
+ * @return The string value.
*/
public String getValueString() {
if (super.getElementValueType() != STRING) {
diff --git a/src/main/java/org/apache/bcel/generic/Type.java
b/src/main/java/org/apache/bcel/generic/Type.java
index c27886ec..91f580a0 100644
--- a/src/main/java/org/apache/bcel/generic/Type.java
+++ b/src/main/java/org/apache/bcel/generic/Type.java
@@ -195,7 +195,7 @@ public abstract class Type {
* Gets the signature for a method.
*
* @param meth the method.
- * @return the method signature.
+ * @return The method signature.
*/
public static String getSignature(final java.lang.reflect.Method meth) {
final StringBuilder sb = new StringBuilder("(");
@@ -388,7 +388,7 @@ public abstract class Type {
/**
* Gets the class name.
*
- * @return the class name.
+ * @return The class name.
*/
public String getClassName() {
return toString();
@@ -443,7 +443,7 @@ public abstract class Type {
* boolean, short and char variable are considered as int in the stack or
local variable area. Returns {@link #INT}
* for {@link #BOOLEAN}, {@link #SHORT} or {@link #CHAR}, otherwise
returns the given type.
*
- * @return the normalized type.
+ * @return The normalized type.
* @since 6.0
*/
public Type normalizeForStackOrLocal() {
diff --git a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
index 7a45e7f0..deb40158 100644
--- a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
@@ -27,7 +27,7 @@ public interface TypedInstruction {
* Gets the type associated with this instruction.
*
* @param cpg the constant pool generator.
- * @return the type associated with this instruction.
+ * @return The type associated with this instruction.
*/
Type getType(ConstantPoolGen cpg);
}
diff --git
a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
index 7903c5c1..14ed163b 100644
--- a/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
+++ b/src/main/java/org/apache/bcel/util/AbstractClassPathRepository.java
@@ -103,7 +103,7 @@ abstract class AbstractClassPathRepository implements
Repository {
* the Repository's classpath is searched for the class (and it is added
to the Repository if found).
*
* @param className the name of the class.
- * @return the JavaClass object.
+ * @return The JavaClass object.
* @throws ClassNotFoundException if the class is not in the Repository,
and could not be found on the classpath
*/
@Override
diff --git a/src/main/java/org/apache/bcel/util/BCELifier.java
b/src/main/java/org/apache/bcel/util/BCELifier.java
index eb5fb507..0dc2df70 100644
--- a/src/main/java/org/apache/bcel/util/BCELifier.java
+++ b/src/main/java/org/apache/bcel/util/BCELifier.java
@@ -130,7 +130,7 @@ public class BCELifier extends
org.apache.bcel.classfile.EmptyVisitor {
*
* @param flags the flags field to interpret.
* @param location the item type.
- * @return the formatted string.
+ * @return The formatted string.
* @since 6.0 made public
*/
public static String printFlags(final int flags, final FLAGS location) {
diff --git a/src/main/java/org/apache/bcel/util/ByteSequence.java
b/src/main/java/org/apache/bcel/util/ByteSequence.java
index 048be4fe..075f03dd 100644
--- a/src/main/java/org/apache/bcel/util/ByteSequence.java
+++ b/src/main/java/org/apache/bcel/util/ByteSequence.java
@@ -60,7 +60,7 @@ public final class ByteSequence extends DataInputStream {
/**
* Gets the current index.
*
- * @return the current index.
+ * @return The current index.
*/
public int getIndex() {
return byteStream.getPosition();
diff --git a/src/main/java/org/apache/bcel/util/ClassLoader.java
b/src/main/java/org/apache/bcel/util/ClassLoader.java
index 172c8c56..8a99ea24 100644
--- a/src/main/java/org/apache/bcel/util/ClassLoader.java
+++ b/src/main/java/org/apache/bcel/util/ClassLoader.java
@@ -118,7 +118,7 @@ public class ClassLoader extends java.lang.ClassLoader {
* </p>
*
* @param className compressed byte code with "$$BCEL$$" in it.
- * @return the created JavaClass.
+ * @return The created JavaClass.
*/
protected JavaClass createClass(final String className) {
final int index = className.indexOf(BCEL_TOKEN);
@@ -188,7 +188,7 @@ public class ClassLoader extends java.lang.ClassLoader {
* Override this method if you want to alter a class before it gets
actually loaded. Does nothing by default.
*
* @param clazz the class to modify.
- * @return the modified class.
+ * @return The modified class.
*/
protected JavaClass modifyClass(final JavaClass clazz) {
return clazz;
diff --git a/src/main/java/org/apache/bcel/util/ClassQueue.java
b/src/main/java/org/apache/bcel/util/ClassQueue.java
index fa5b4812..bc6ca165 100644
--- a/src/main/java/org/apache/bcel/util/ClassQueue.java
+++ b/src/main/java/org/apache/bcel/util/ClassQueue.java
@@ -42,7 +42,7 @@ public class ClassQueue {
/**
* Removes and returns the first JavaClass from the queue.
*
- * @return the first JavaClass from the queue.
+ * @return The first JavaClass from the queue.
*/
public JavaClass dequeue() {
return vec.removeFirst();
diff --git a/src/main/java/org/apache/bcel/util/ClassSet.java
b/src/main/java/org/apache/bcel/util/ClassSet.java
index 2b2797bf..084e204b 100644
--- a/src/main/java/org/apache/bcel/util/ClassSet.java
+++ b/src/main/java/org/apache/bcel/util/ClassSet.java
@@ -61,7 +61,7 @@ public class ClassSet {
/**
* Gets the class names in the set.
*
- * @return the class names in the set.
+ * @return The class names in the set.
*/
public String[] getClassNames() {
return map.keySet().toArray(ArrayUtils.EMPTY_STRING_ARRAY);
diff --git a/src/main/java/org/apache/bcel/util/ClassStack.java
b/src/main/java/org/apache/bcel/util/ClassStack.java
index e8a80dd9..9fc228a7 100644
--- a/src/main/java/org/apache/bcel/util/ClassStack.java
+++ b/src/main/java/org/apache/bcel/util/ClassStack.java
@@ -49,7 +49,7 @@ public class ClassStack {
/**
* Pops a JavaClass from the stack.
*
- * @return the JavaClass from the top of the stack.
+ * @return The JavaClass from the top of the stack.
*/
public JavaClass pop() {
return stack.pop();
@@ -67,7 +67,7 @@ public class ClassStack {
/**
* Gets the top JavaClass from the stack without removing it.
*
- * @return the JavaClass at the top of the stack.
+ * @return The JavaClass at the top of the stack.
*/
public JavaClass top() {
return stack.peek();
diff --git a/src/main/java/org/apache/bcel/util/ClassVector.java
b/src/main/java/org/apache/bcel/util/ClassVector.java
index 890c48f1..d91f899b 100644
--- a/src/main/java/org/apache/bcel/util/ClassVector.java
+++ b/src/main/java/org/apache/bcel/util/ClassVector.java
@@ -62,7 +62,7 @@ public class ClassVector implements Serializable {
* Gets the JavaClass at the specified index.
*
* @param index the index.
- * @return the JavaClass at the specified index.
+ * @return The JavaClass at the specified index.
*/
public JavaClass elementAt(final int index) {
return vec.get(index);
diff --git a/src/main/java/org/apache/bcel/util/InstructionFinder.java
b/src/main/java/org/apache/bcel/util/InstructionFinder.java
index 2e36b415..0157a682 100644
--- a/src/main/java/org/apache/bcel/util/InstructionFinder.java
+++ b/src/main/java/org/apache/bcel/util/InstructionFinder.java
@@ -254,14 +254,14 @@ public class InstructionFinder {
/**
* Gets the inquired instruction list.
*
- * @return the inquired instruction list.
+ * @return The inquired instruction list.
*/
public final InstructionList getInstructionList() {
return il;
}
/**
- * @return the matched piece of code as an array of instruction (handles).
+ * @return The matched piece of code as an array of instruction (handles).
*/
private InstructionHandle[] getMatch(final int matchedFrom, final int
matchLength) {
return Arrays.copyOfRange(handles, matchedFrom, matchedFrom +
matchLength);
diff --git a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
index 612c3fa6..5d05b05b 100644
--- a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
+++ b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
@@ -92,7 +92,7 @@ public class ModularRuntimeImage implements Closeable {
/**
* Gets the file system.
*
- * @return the file system.
+ * @return The file system.
*/
public FileSystem getFileSystem() {
return fileSystem;
diff --git a/src/main/java/org/apache/bcel/util/Repository.java
b/src/main/java/org/apache/bcel/util/Repository.java
index c617b523..dbb5c6f6 100644
--- a/src/main/java/org/apache/bcel/util/Repository.java
+++ b/src/main/java/org/apache/bcel/util/Repository.java
@@ -37,14 +37,14 @@ public interface Repository {
* Finds the class with the name provided, if the class isn't there,
return NULL.
*
* @param className the class name.
- * @return the JavaClass instance, or null.
+ * @return The JavaClass instance, or null.
*/
JavaClass findClass(String className);
/**
* Gets the ClassPath associated with this Repository.
*
- * @return the ClassPath.
+ * @return The ClassPath.
*/
ClassPath getClassPath();
@@ -52,7 +52,7 @@ public interface Repository {
* Finds the JavaClass instance for the given run-time class object.
*
* @param clazz the class.
- * @return the JavaClass instance.
+ * @return The JavaClass instance.
* @throws ClassNotFoundException if the class can't be found.
*/
JavaClass loadClass(Class<?> clazz) throws ClassNotFoundException;
@@ -61,7 +61,7 @@ public interface Repository {
* Finds the class with the name provided, if the class isn't there, make
an attempt to load it.
*
* @param className the class name.
- * @return the JavaClass instance.
+ * @return The JavaClass instance.
* @throws ClassNotFoundException if the class can't be found.
*/
JavaClass loadClass(String className) throws ClassNotFoundException;
diff --git a/src/main/java/org/apache/bcel/util/SyntheticRepository.java
b/src/main/java/org/apache/bcel/util/SyntheticRepository.java
index ecc3ab20..7b2451e2 100644
--- a/src/main/java/org/apache/bcel/util/SyntheticRepository.java
+++ b/src/main/java/org/apache/bcel/util/SyntheticRepository.java
@@ -39,7 +39,7 @@ public class SyntheticRepository extends
MemorySensitiveClassPathRepository {
/**
* Gets the singleton instance for the system class path.
*
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static SyntheticRepository getInstance() {
return getInstance(ClassPath.SYSTEM_CLASS_PATH);
@@ -49,7 +49,7 @@ public class SyntheticRepository extends
MemorySensitiveClassPathRepository {
* Gets the singleton instance for the given class path.
*
* @param classPath the class path.
- * @return the singleton instance.
+ * @return The singleton instance.
*/
public static SyntheticRepository getInstance(final ClassPath classPath) {
return MAP.computeIfAbsent(classPath, SyntheticRepository::new);
diff --git a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
index b714e40e..be9662fb 100644
--- a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
@@ -74,7 +74,7 @@ public abstract class PassVerifier {
/**
* Returns the (warning) messages that this PassVerifier accumulated
during its do_verify()ing work.
*
- * @return the (warning) messages.
+ * @return The (warning) messages.
* @see #addMessage(String)
* @see #do_verify()
*/
@@ -85,7 +85,7 @@ public abstract class PassVerifier {
/**
* Returns the (warning) messages that this PassVerifier accumulated
during its do_verify()ing work.
*
- * @return the list of messages.
+ * @return The list of messages.
* @see #addMessage(String)
* @see #do_verify()
*/
diff --git a/src/main/java/org/apache/bcel/verifier/VerificationResult.java
b/src/main/java/org/apache/bcel/verifier/VerificationResult.java
index 557ed8b2..ac0b8a87 100644
--- a/src/main/java/org/apache/bcel/verifier/VerificationResult.java
+++ b/src/main/java/org/apache/bcel/verifier/VerificationResult.java
@@ -88,7 +88,7 @@ public class VerificationResult {
/**
* Returns a detailed message.
*
- * @return the detail message.
+ * @return The detail message.
*/
public String getMessage() {
return detailMessage;
@@ -97,7 +97,7 @@ public class VerificationResult {
/**
* Returns one of the {@link #VERIFIED_OK}, {@link #VERIFIED_NOTYET},
{@link #VERIFIED_REJECTED} constants.
*
- * @return the verification status.
+ * @return The verification status.
*/
public int getStatus() {
return numeric;
diff --git a/src/main/java/org/apache/bcel/verifier/Verifier.java
b/src/main/java/org/apache/bcel/verifier/Verifier.java
index 4fa7474f..6a874a81 100644
--- a/src/main/java/org/apache/bcel/verifier/Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/Verifier.java
@@ -137,7 +137,7 @@ public class Verifier {
/**
* Returns the VerificationResult for the given pass.
*
- * @return the VerificationResult for pass 1.
+ * @return The VerificationResult for pass 1.
*/
public VerificationResult doPass1() {
if (p1v == null) {
@@ -149,7 +149,7 @@ public class Verifier {
/**
* Returns the VerificationResult for the given pass.
*
- * @return the VerificationResult for pass 2.
+ * @return The VerificationResult for pass 2.
*/
public VerificationResult doPass2() {
if (p2v == null) {
@@ -162,7 +162,7 @@ public class Verifier {
* Returns the VerificationResult for the given pass.
*
* @param methodNo The method to verify.
- * @return the VerificationResult.
+ * @return The VerificationResult.
*/
public VerificationResult doPass3a(final int methodNo) {
return p3avs.computeIfAbsent(Integer.toString(methodNo), k -> new
Pass3aVerifier(this, methodNo)).verify();
@@ -172,7 +172,7 @@ public class Verifier {
* Returns the VerificationResult for the given pass.
*
* @param methodNo The method to verify.
- * @return the VerificationResult.
+ * @return The VerificationResult.
*/
public VerificationResult doPass3b(final int methodNo) {
return p3bvs.computeIfAbsent(Integer.toString(methodNo), k -> new
Pass3bVerifier(this, methodNo)).verify();
@@ -194,7 +194,7 @@ public class Verifier {
* created recursively by another Verifier and you got a reference to this
Verifier by the getVerifiers() method of the
* VerifierFactory.
*
- * @return the class name.
+ * @return The class name.
* @see VerifierFactory
*/
public final String getClassName() {
@@ -205,7 +205,7 @@ public class Verifier {
* This returns all the (warning) messages collected during verification.
A prefix shows from which verifying pass a
* message originates.
*
- * @return the array of messages.
+ * @return The array of messages.
* @throws ClassNotFoundException if this class can't be found.
*/
public String[] getMessages() throws ClassNotFoundException {
diff --git a/src/main/java/org/apache/bcel/verifier/VerifierAppFrame.java
b/src/main/java/org/apache/bcel/verifier/VerifierAppFrame.java
index ea9f3c40..481a6cf4 100644
--- a/src/main/java/org/apache/bcel/verifier/VerifierAppFrame.java
+++ b/src/main/java/org/apache/bcel/verifier/VerifierAppFrame.java
@@ -159,7 +159,7 @@ public class VerifierAppFrame extends JFrame {
}
/**
- * @return the classNamesJList.
+ * @return The classNamesJList.
*/
JList<String> getClassNamesJList() {
return classNamesJList;
diff --git a/src/main/java/org/apache/bcel/verifier/VerifierFactory.java
b/src/main/java/org/apache/bcel/verifier/VerifierFactory.java
index 9326d92e..529bb53a 100644
--- a/src/main/java/org/apache/bcel/verifier/VerifierFactory.java
+++ b/src/main/java/org/apache/bcel/verifier/VerifierFactory.java
@@ -75,7 +75,7 @@ public class VerifierFactory {
* transparently created.
*
* @param fullyQualifiedClassName the fully qualified class name.
- * @return the (only) verifier responsible for the class with the given
name.
+ * @return The (only) verifier responsible for the class with the given
name.
*/
public static Verifier getVerifier(final String fullyQualifiedClassName) {
return MAP.computeIfAbsent(fullyQualifiedClassName, k -> {
diff --git
a/src/main/java/org/apache/bcel/verifier/exc/AssertionViolatedException.java
b/src/main/java/org/apache/bcel/verifier/exc/AssertionViolatedException.java
index 76f985f6..ee96fe98 100644
--- a/src/main/java/org/apache/bcel/verifier/exc/AssertionViolatedException.java
+++ b/src/main/java/org/apache/bcel/verifier/exc/AssertionViolatedException.java
@@ -92,7 +92,7 @@ public final class AssertionViolatedException extends
RuntimeException {
/**
* Returns the error message string of this AssertionViolatedException
object.
*
- * @return the error message string of this AssertionViolatedException.
+ * @return The error message string of this AssertionViolatedException.
*/
@Override
public String getMessage() {
diff --git a/src/main/java/org/apache/bcel/verifier/exc/Utility.java
b/src/main/java/org/apache/bcel/verifier/exc/Utility.java
index fae5dfef..c1c6b7bc 100644
--- a/src/main/java/org/apache/bcel/verifier/exc/Utility.java
+++ b/src/main/java/org/apache/bcel/verifier/exc/Utility.java
@@ -31,7 +31,7 @@ public final class Utility {
* This method returns the stack trace of a Throwable instance as a String.
*
* @param t the Throwable instance.
- * @return the stack trace as a String.
+ * @return The stack trace as a String.
* @deprecated Use {@link ExceptionUtils#getStackTrace(Throwable)}.
*/
public static String getStackTrace(final Throwable t) {
diff --git
a/src/main/java/org/apache/bcel/verifier/exc/VerifierConstraintViolatedException.java
b/src/main/java/org/apache/bcel/verifier/exc/VerifierConstraintViolatedException.java
index 56f1d533..129b1649 100644
---
a/src/main/java/org/apache/bcel/verifier/exc/VerifierConstraintViolatedException.java
+++
b/src/main/java/org/apache/bcel/verifier/exc/VerifierConstraintViolatedException.java
@@ -78,7 +78,7 @@ public abstract class VerifierConstraintViolatedException
extends RuntimeExcepti
/**
* Returns the error message string of this
VerifierConstraintViolatedException object.
*
- * @return the error message string of this
VerifierConstraintViolatedException.
+ * @return The error message string of this
VerifierConstraintViolatedException.
*/
@Override
public String getMessage() {
diff --git a/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
b/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
index f71af0fa..538714de 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/DOUBLE_Upper.java
@@ -32,7 +32,7 @@ public final class DOUBLE_Upper extends Type {
/**
* Gets the single instance of this class.
*
- * @return the single instance of this class.
+ * @return The single instance of this class.
*/
public static DOUBLE_Upper theInstance() {
return INSTANCE;
diff --git a/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
b/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
index f2e69ce7..5f443d3e 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/LONG_Upper.java
@@ -32,7 +32,7 @@ public final class LONG_Upper extends Type {
/**
* Gets the single instance of this class.
*
- * @return the single instance of this class.
+ * @return The single instance of this class.
*/
public static LONG_Upper theInstance() {
return INSTANCE;
diff --git
a/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
b/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
index b9cf33a1..2f9ccbc4 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java
@@ -80,7 +80,7 @@ public class LocalVariableInfo {
* about the type of this local variable slot at the given bytecode offset.
*
* @param offset bytecode offset.
- * @return the name of the local variable that uses this local variable
slot at the given bytecode offset.
+ * @return The name of the local variable that uses this local variable
slot at the given bytecode offset.
*/
public String getName(final int offset) {
return names.get(Integer.toString(offset));
@@ -92,7 +92,7 @@ public class LocalVariableInfo {
* about the type of this local variable slot at the given bytecode offset.
*
* @param offset bytecode offset.
- * @return the type of the local variable that uses this local variable
slot at the given bytecode offset.
+ * @return The type of the local variable that uses this local variable
slot at the given bytecode offset.
*/
public Type getType(final int offset) {
return types.get(Integer.toString(offset));
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
index 94627520..38aae366 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass2Verifier.java
@@ -1452,7 +1452,7 @@ public final class Pass2Verifier extends PassVerifier
implements Constants {
* Leave that to JustIce.
*
* @param methodNr the method number.
- * @return the LocalVariablesInfo object or null.
+ * @return The LocalVariablesInfo object or null.
*/
public LocalVariablesInfo getLocalVariablesInfo(final int methodNr) {
if (verify() != VerificationResult.VR_OK) {
diff --git a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
index bfde59f0..4f0b5146 100644
--- a/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/statics/Pass3aVerifier.java
@@ -140,7 +140,7 @@ public final class Pass3aVerifier extends PassVerifier {
*
* @param jc the class that defines the referenced method.
* @param invoke the instruction that references the method.
- * @return the referenced method or null if not found.
+ * @return The referenced method or null if not found.
*/
private Method getMethod(final JavaClass jc, final InvokeInstruction
invoke) {
final Method[] ms = jc.getMethods();
@@ -161,7 +161,7 @@ public final class Pass3aVerifier extends PassVerifier {
*
* @param jc the class that defines the referenced method.
* @param invoke the instruction that references the method.
- * @return the referenced method or null if not found.
+ * @return The referenced method or null if not found.
*/
private Method getMethodRecursive(final JavaClass jc, final
InvokeInstruction invoke) throws ClassNotFoundException {
Method m;
@@ -1077,7 +1077,7 @@ public final class Pass3aVerifier extends PassVerifier {
/**
* Returns the method number as supplied when instantiating.
*
- * @return the method number.
+ * @return The method number.
*/
public int getMethodNo() {
return methodNo;
@@ -1207,7 +1207,7 @@ public final class Pass3aVerifier extends PassVerifier {
* RuntimeException, or else it is a string derived only from obj's class
name.
*
* @param obj the object to convert to string.
- * @return the string representation.
+ * @return The string representation.
*/
protected String tostring(final Object obj) {
String ret;
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
b/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
index f4cee140..7fc93d9a 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/ControlFlowGraph.java
@@ -393,7 +393,7 @@ public class ControlFlowGraph {
* Returns the InstructionContext of a given instruction.
*
* @param inst the instruction handle.
- * @return the InstructionContext of the given instruction.
+ * @return The InstructionContext of the given instruction.
*/
public InstructionContext contextOf(final InstructionHandle inst) {
final InstructionContext ic = instructionContexts.get(inst);
@@ -407,7 +407,7 @@ public class ControlFlowGraph {
* Returns the InstructionContext[] of a given InstructionHandle[], in a
naturally ordered manner.
*
* @param insts the instruction handles.
- * @return the InstructionContext array of the given instruction handles.
+ * @return The InstructionContext array of the given instruction handles.
*/
public InstructionContext[] contextsOf(final InstructionHandle[] insts) {
final InstructionContext[] ret = new InstructionContext[insts.length];
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
b/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
index 881f1d88..dad837f6 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/ExceptionHandler.java
@@ -44,7 +44,7 @@ public class ExceptionHandler {
/**
* Returns the type of the exception that's handled. <strong>'null' means
'ANY'.</strong>
*
- * @return the exception type.
+ * @return The exception type.
*/
public ObjectType getExceptionType() {
return catchType;
@@ -53,7 +53,7 @@ public class ExceptionHandler {
/**
* Returns the InstructionHandle where the handler starts off.
*
- * @return the handler start instruction.
+ * @return The handler start instruction.
*/
public InstructionHandle getHandlerStart() {
return handlerPc;
diff --git a/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
b/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
index d126224c..97e2e2cf 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
@@ -36,7 +36,7 @@ public class Frame {
/**
* Gets the static _this reference.
*
- * @return the _this.
+ * @return The _this.
* @since 6.0
*/
public static UninitializedObjectType getThis() {
@@ -122,7 +122,7 @@ public class Frame {
/**
* Gets the local variables.
*
- * @return the local variables.
+ * @return The local variables.
*/
public LocalVariables getLocals() {
return locals;
@@ -131,7 +131,7 @@ public class Frame {
/**
* Gets the operand stack.
*
- * @return the operand stack.
+ * @return The operand stack.
*/
public OperandStack getStack() {
return stack;
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/InstructionContext.java
b/src/main/java/org/apache/bcel/verifier/structurals/InstructionContext.java
index f708f330..52c39096 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/InstructionContext.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/InstructionContext.java
@@ -49,14 +49,14 @@ public interface InstructionContext {
/**
* Returns the exception handlers that protect this instruction. They are
special control flow successors.
*
- * @return the exception handlers.
+ * @return The exception handlers.
*/
ExceptionHandler[] getExceptionHandlers();
/**
* Gets the incoming frame.
*
- * @return the incoming frame.
+ * @return The incoming frame.
*/
Frame getInFrame();
@@ -72,7 +72,7 @@ public interface InstructionContext {
* ArrayList) first.</B>
*
* @param executionPredecessors the execution predecessors.
- * @return the outgoing frame.
+ * @return The outgoing frame.
* @see #execute(Frame, ArrayList, InstConstraintVisitor, ExecutionVisitor)
*/
Frame getOutFrame(ArrayList<InstructionContext> executionPredecessors);
@@ -80,7 +80,7 @@ public interface InstructionContext {
/**
* Returns the usual control flow successors.
*
- * @return the successors.
+ * @return The successors.
* @see #getExceptionHandlers()
*/
InstructionContext[] getSuccessors();
@@ -89,7 +89,7 @@ public interface InstructionContext {
* The getTag and setTag methods may be used for temporary flagging, such
as graph coloring. Nothing in the
* InstructionContext object depends on the value of the tag. JustIce does
not use it.
*
- * @return the tag value.
+ * @return The tag value.
* @see #setTag(int tag)
*/
int getTag();
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
index 032a2fd0..874f23ba 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
@@ -77,7 +77,7 @@ public class LocalVariables implements Cloneable {
* Returns the type of the local variable slot index.
*
* @param slotIndex Slot to look up.
- * @return the type of the local variable slot index.
+ * @return The type of the local variable slot index.
*/
public Type get(final int slotIndex) {
return locals[slotIndex];
@@ -117,7 +117,7 @@ public class LocalVariables implements Cloneable {
/**
* Returns the number of local variable slots.
*
- * @return the number of local variable slots.
+ * @return The number of local variable slots.
*/
public int maxLocals() {
return locals.length;
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
b/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
index cc8465ed..84eb7095 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
@@ -135,7 +135,7 @@ public class OperandStack implements Cloneable {
/**
* Returns the number of stack slots this stack can hold.
*
- * @return the maximum stack size.
+ * @return The maximum stack size.
*/
public int maxStack() {
return this.maxStack;
@@ -186,7 +186,7 @@ public class OperandStack implements Cloneable {
/**
* Returns the element on top of the stack. The element is not popped off
the stack!
*
- * @return the top element.
+ * @return The top element.
*/
public Type peek() {
return peek(0);
@@ -197,7 +197,7 @@ public class OperandStack implements Cloneable {
* element is not popped off the stack!
*
* @param i the depth.
- * @return the element at the specified depth.
+ * @return The element at the specified depth.
*/
public Type peek(final int i) {
return stack.get(size() - i - 1);
@@ -206,7 +206,7 @@ public class OperandStack implements Cloneable {
/**
* Returns the element on top of the stack. The element is popped off the
stack.
*
- * @return the popped element.
+ * @return The popped element.
*/
public Type pop() {
return stack.remove(size() - 1);
@@ -246,7 +246,7 @@ public class OperandStack implements Cloneable {
/**
* Returns the size of this OperandStack; that means, how many Type
objects there are.
*
- * @return the stack size.
+ * @return The stack size.
*/
public int size() {
return stack.size();
@@ -255,7 +255,7 @@ public class OperandStack implements Cloneable {
/**
* Returns the number of stack slots used.
*
- * @return the number of slots used.
+ * @return The number of slots used.
* @see #maxStack()
*/
public int slotsUsed() {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
b/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
index ca8f6058..d570346b 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Pass3bVerifier.java
@@ -92,7 +92,7 @@ public final class Pass3bVerifier extends PassVerifier {
* Gets a specific ExecutionChain from the queue.
*
* @param i the index of the item to be fetched.
- * @return the indicated ExecutionChain.
+ * @return The indicated ExecutionChain.
*/
public ArrayList<InstructionContext> getEC(final int i) {
return ecs.get(i);
@@ -102,7 +102,7 @@ public final class Pass3bVerifier extends PassVerifier {
* Gets a specific InstructionContext from the queue.
*
* @param i the index of the item to be fetched.
- * @return the indicated InstructionContext.
+ * @return The indicated InstructionContext.
*/
public InstructionContext getIC(final int i) {
return ics.get(i);
@@ -130,7 +130,7 @@ public final class Pass3bVerifier extends PassVerifier {
/**
* Gets the size of the InstructionContext queue.
*
- * @return the size of the InstructionQueue.
+ * @return The size of the InstructionQueue.
*/
public int size() {
return ics.size();
@@ -410,7 +410,7 @@ public final class Pass3bVerifier extends PassVerifier {
/**
* Returns the method number as supplied when instantiating.
*
- * @return the method number.
+ * @return The method number.
*/
public int getMethodNo() {
return methodNo;
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
b/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
index 4694a778..d809fa45 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Subroutines.java
@@ -552,7 +552,7 @@ public class Subroutines {
* You must not use this to get the top-level instructions modeled as a
Subroutine object.
*
* @param leader the leader instruction handle.
- * @return the Subroutine object.
+ * @return The Subroutine object.
* @see #getTopLevel()
*/
public Subroutine getSubroutine(final InstructionHandle leader) {
@@ -574,7 +574,7 @@ public class Subroutines {
* object. It is a special Subroutine object where <B>you must not invoke
getEnteringJsrInstructions() or
* getLeavingRET()</B>.
*
- * @return the top-level Subroutine.
+ * @return The top-level Subroutine.
* @see Subroutine#getEnteringJsrInstructions()
* @see Subroutine#getLeavingRET()
*/
@@ -615,7 +615,7 @@ public class Subroutines {
* for example code that can never be executed.
*
* @param any the instruction handle.
- * @return the Subroutine object or null.
+ * @return The Subroutine object or null.
* @see #getSubroutine(InstructionHandle)
* @see #getTopLevel()
*/
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
b/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
index 668cdb58..9f447daf 100644
---
a/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
+++
b/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
@@ -58,7 +58,7 @@ public class UninitializedObjectType extends ReferenceType
implements Constants
* Returns the ObjectType of the same class as the one of the
uninitialized object represented by this
* UninitializedObjectType instance.
*
- * @return the ObjectType.
+ * @return The ObjectType.
*/
public ObjectType getInitialized() {
return initialized;
