This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-bcel.git
commit 23d980a7742308e4da3c862a3e31f91bd242cefe Author: Gary Gregory <[email protected]> AuthorDate: Fri Feb 13 17:32:51 2026 -0500 Javadoc --- .../java/org/apache/bcel/classfile/LineNumber.java | 12 ++++++++ .../org/apache/bcel/classfile/LineNumberTable.java | 11 +++++++ .../apache/bcel/classfile/LocalVariableTable.java | 17 +++++++++++ .../bcel/classfile/LocalVariableTypeTable.java | 34 ++++++++++++++++++++++ .../apache/bcel/classfile/MethodParameters.java | 10 +++++++ .../java/org/apache/bcel/classfile/Module.java | 8 +++++ .../org/apache/bcel/classfile/ModuleExports.java | 5 ++++ .../org/apache/bcel/classfile/ModuleMainClass.java | 6 ++++ .../org/apache/bcel/classfile/ModuleOpens.java | 5 ++++ .../org/apache/bcel/classfile/ModulePackages.java | 10 +++++++ .../org/apache/bcel/classfile/ModuleProvides.java | 5 ++++ .../org/apache/bcel/classfile/ModuleRequires.java | 5 ++++ .../org/apache/bcel/generic/INVOKEDYNAMIC.java | 5 ++++ .../org/apache/bcel/generic/INVOKEINTERFACE.java | 8 +++++ .../org/apache/bcel/generic/INVOKESPECIAL.java | 5 ++++ .../java/org/apache/bcel/generic/INVOKESTATIC.java | 5 ++++ .../org/apache/bcel/generic/INVOKEVIRTUAL.java | 5 ++++ src/main/java/org/apache/bcel/generic/IOR.java | 3 ++ src/main/java/org/apache/bcel/generic/ISHL.java | 3 ++ src/main/java/org/apache/bcel/generic/ISHR.java | 3 ++ src/main/java/org/apache/bcel/generic/IUSHR.java | 3 ++ src/main/java/org/apache/bcel/generic/IXOR.java | 3 ++ .../apache/bcel/generic/InstructionFactory.java | 3 +- .../org/apache/bcel/generic/InstructionList.java | 2 ++ src/main/java/org/apache/bcel/generic/JSR.java | 5 ++++ src/main/java/org/apache/bcel/generic/JSR_W.java | 5 ++++ src/main/java/org/apache/bcel/generic/L2D.java | 3 ++ src/main/java/org/apache/bcel/generic/L2F.java | 3 ++ src/main/java/org/apache/bcel/generic/L2I.java | 3 ++ src/main/java/org/apache/bcel/generic/LADD.java | 3 ++ src/main/java/org/apache/bcel/generic/LAND.java | 3 ++ src/main/java/org/apache/bcel/generic/LCMP.java | 3 ++ src/main/java/org/apache/bcel/generic/LCONST.java | 5 ++++ src/main/java/org/apache/bcel/generic/LDC.java | 15 +++++++++- src/main/java/org/apache/bcel/generic/LDC2_W.java | 11 +++++++ src/main/java/org/apache/bcel/generic/LDC_W.java | 5 ++++ src/main/java/org/apache/bcel/generic/LDIV.java | 3 ++ src/main/java/org/apache/bcel/generic/LLOAD.java | 5 ++++ src/main/java/org/apache/bcel/generic/LMUL.java | 3 ++ src/main/java/org/apache/bcel/generic/LNEG.java | 3 ++ .../java/org/apache/bcel/generic/LOOKUPSWITCH.java | 7 +++++ src/main/java/org/apache/bcel/generic/LOR.java | 3 ++ src/main/java/org/apache/bcel/generic/LREM.java | 3 ++ src/main/java/org/apache/bcel/generic/LRETURN.java | 3 ++ src/main/java/org/apache/bcel/generic/LSHL.java | 3 ++ src/main/java/org/apache/bcel/generic/LSHR.java | 3 ++ src/main/java/org/apache/bcel/generic/LSTORE.java | 5 ++++ src/main/java/org/apache/bcel/generic/LSUB.java | 3 ++ src/main/java/org/apache/bcel/generic/LUSHR.java | 3 ++ src/main/java/org/apache/bcel/generic/LXOR.java | 3 ++ .../org/apache/bcel/generic/LineNumberGen.java | 23 +++++++++++++++ .../java/org/apache/bcel/generic/MONITORENTER.java | 3 ++ .../java/org/apache/bcel/generic/MONITOREXIT.java | 3 ++ .../org/apache/bcel/generic/MethodObserver.java | 5 ++++ src/main/java/org/apache/bcel/generic/Select.java | 11 ++++++- .../java/org/apache/bcel/util/JavaWrapper.java | 11 +++++++ .../bcel/util/LruCacheClassPathRepository.java | 6 ++++ .../util/MemorySensitiveClassPathRepository.java | 5 ++++ .../org/apache/bcel/util/ModularRuntimeImage.java | 5 ++++ .../bcel/verifier/exc/InvalidMethodException.java | 6 +++- .../verifier/exc/LinkingConstraintException.java | 6 ++++ .../apache/bcel/verifier/exc/LoadingException.java | 2 ++ .../LocalVariableInfoInconsistentException.java | 2 ++ .../exc/StructuralCodeConstraintException.java | 2 ++ .../bcel/verifier/statics/LocalVariableInfo.java | 6 ++++ 65 files changed, 382 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/bcel/classfile/LineNumber.java b/src/main/java/org/apache/bcel/classfile/LineNumber.java index dfb7b501..a367b839 100644 --- a/src/main/java/org/apache/bcel/classfile/LineNumber.java +++ b/src/main/java/org/apache/bcel/classfile/LineNumber.java @@ -51,6 +51,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Constructs a LineNumber. + * * @param startPc Program Counter (PC) corresponds to. * @param lineNumber line number in source file. */ @@ -80,6 +82,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Creates a deep copy of this object. + * * @return deep copy of this object. */ public LineNumber copy() { @@ -103,6 +107,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Gets the line number. + * * @return Corresponding source line. */ public int getLineNumber() { @@ -110,6 +116,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Gets the program counter. + * * @return PC in code. */ public int getStartPC() { @@ -117,6 +125,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Sets the line number. + * * @param lineNumber the source line number. */ public void setLineNumber(final int lineNumber) { @@ -124,6 +134,8 @@ public final class LineNumber implements Cloneable, Node { } /** + * Sets the program counter. + * * @param startPc the pc for this line number. */ public void setStartPC(final int startPc) { diff --git a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java index a4c33343..77e550be 100644 --- a/src/main/java/org/apache/bcel/classfile/LineNumberTable.java +++ b/src/main/java/org/apache/bcel/classfile/LineNumberTable.java @@ -78,6 +78,8 @@ public final class LineNumberTable extends Attribute implements Iterable<LineNum * <p> * Note that both objects use the same references (shallow copy). Use copy() for a physical copy. * </p> + * + * @param c the instance to copy. */ public LineNumberTable(final LineNumberTable c) { this(c.getNameIndex(), c.getLength(), c.getLineNumberTable(), c.getConstantPool()); @@ -124,6 +126,8 @@ public final class LineNumberTable extends Attribute implements Iterable<LineNum } /** + * Gets the line number table. + * * @return Array of (pc offset, line number) pairs. */ public LineNumber[] getLineNumberTable() { @@ -176,6 +180,11 @@ public final class LineNumberTable extends Attribute implements Iterable<LineNum return lineNumberTable[minIndex].getLineNumber(); } + /** + * Gets the length of the line number table. + * + * @return the length of the line number table. + */ public int getTableLength() { return lineNumberTable.length; } @@ -186,6 +195,8 @@ public final class LineNumberTable extends Attribute implements Iterable<LineNum } /** + * Sets the line number table. + * * @param lineNumberTable the line number entries for this table. */ public void setLineNumberTable(final LineNumber[] lineNumberTable) { diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java index 4254fa17..2fec2a8a 100644 --- a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java +++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java @@ -60,6 +60,8 @@ public class LocalVariableTable extends Attribute implements Iterable<LocalVaria } /** + * Constructs a new LocalVariableTable. + * * @param nameIndex Index in constant pool to 'LocalVariableTable'. * @param length Content length in bytes. * @param localVariableTable Table of local variables. @@ -120,6 +122,8 @@ 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. * @deprecated Since 5.2 because multiple variables can share the same slot, use getLocalVariable(int index, int pc) instead. @@ -135,6 +139,7 @@ public class LocalVariableTable extends Attribute implements Iterable<LocalVaria } /** + * Gets the local variable for the given index and program counter. * * @param index the variable slot. * @param pc the current pc that this variable is alive. @@ -154,12 +159,19 @@ public class LocalVariableTable extends Attribute implements Iterable<LocalVaria } /** + * Gets the local variable table. + * * @return Array of local variables of method. */ public final LocalVariable[] getLocalVariableTable() { return localVariableTable; } + /** + * Gets the table length. + * + * @return the table length. + */ public final int getTableLength() { return localVariableTable.length; } @@ -169,6 +181,11 @@ public class LocalVariableTable extends Attribute implements Iterable<LocalVaria return Stream.of(localVariableTable).iterator(); } + /** + * Sets the local variable table. + * + * @param localVariableTable the local variable table to set. + */ public final void setLocalVariableTable(final LocalVariable[] localVariableTable) { this.localVariableTable = localVariableTable != null ? localVariableTable : EMPTY_ARRAY; } diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java index 87bf9edb..53650517 100644 --- a/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java +++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTypeTable.java @@ -77,12 +77,25 @@ public class LocalVariableTypeTable extends Attribute implements Iterable<LocalV } } + /** + * Constructs a new LocalVariableTypeTable. + * + * @param nameIndex index into constant pool. + * @param length content length in bytes. + * @param localVariableTypeTable the local variable type table. + * @param constantPool the constant pool. + */ public LocalVariableTypeTable(final int nameIndex, final int length, final LocalVariable[] localVariableTypeTable, final ConstantPool constantPool) { super(Const.ATTR_LOCAL_VARIABLE_TYPE_TABLE, nameIndex, length, constantPool); this.localVariableTypeTable = localVariableTypeTable != null ? localVariableTypeTable : LocalVariable.EMPTY_ARRAY; Args.requireU2(this.localVariableTypeTable.length, "localVariableTypeTable.length"); } + /** + * Constructs a copy. + * + * @param c the instance to copy. + */ public LocalVariableTypeTable(final LocalVariableTypeTable c) { this(c.getNameIndex(), c.getLength(), c.getLocalVariableTypeTable(), c.getConstantPool()); } @@ -113,6 +126,12 @@ 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. + */ public final LocalVariable getLocalVariable(final int index) { for (final LocalVariable variable : localVariableTypeTable) { if (variable.getIndex() == index) { @@ -122,10 +141,20 @@ public class LocalVariableTypeTable extends Attribute implements Iterable<LocalV return null; } + /** + * Gets the local variable type table. + * + * @return the local variable type table. + */ public final LocalVariable[] getLocalVariableTypeTable() { return localVariableTypeTable; } + /** + * Gets the table length. + * + * @return the table length. + */ public final int getTableLength() { return localVariableTypeTable == null ? 0 : localVariableTypeTable.length; } @@ -135,6 +164,11 @@ public class LocalVariableTypeTable extends Attribute implements Iterable<LocalV return Stream.of(localVariableTypeTable).iterator(); } + /** + * Sets the local variable table. + * + * @param localVariableTable the local variable table to set. + */ public final void setLocalVariableTable(final LocalVariable[] localVariableTable) { this.localVariableTypeTable = localVariableTable != null ? localVariableTable : EMPTY_ARRAY; } diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameters.java b/src/main/java/org/apache/bcel/classfile/MethodParameters.java index fee2644e..607e13cb 100644 --- a/src/main/java/org/apache/bcel/classfile/MethodParameters.java +++ b/src/main/java/org/apache/bcel/classfile/MethodParameters.java @@ -82,6 +82,11 @@ public class MethodParameters extends Attribute implements Iterable<MethodParame } } + /** + * Gets the method parameters. + * + * @return the method parameters. + */ public MethodParameter[] getParameters() { return parameters; } @@ -91,6 +96,11 @@ public class MethodParameters extends Attribute implements Iterable<MethodParame return Stream.of(parameters).iterator(); } + /** + * Sets the method parameters. + * + * @param parameters the method parameters to set. + */ public void setParameters(final MethodParameter[] parameters) { this.parameters = parameters != null ? parameters : EMPTY_ARRAY; } diff --git a/src/main/java/org/apache/bcel/classfile/Module.java b/src/main/java/org/apache/bcel/classfile/Module.java index 0527850d..bf4f76a1 100644 --- a/src/main/java/org/apache/bcel/classfile/Module.java +++ b/src/main/java/org/apache/bcel/classfile/Module.java @@ -180,6 +180,8 @@ public final class Module extends Attribute { } /** + * Gets the table of exported interfaces. + * * @return table of exported interfaces. * @see ModuleExports */ @@ -209,6 +211,8 @@ public final class Module extends Attribute { } /** + * Gets the table of open interfaces. + * * @return table of provided interfaces. * @see ModuleOpens */ @@ -217,6 +221,8 @@ public final class Module extends Attribute { } /** + * Gets the table of provided interfaces. + * * @return table of provided interfaces. * @see ModuleProvides */ @@ -225,6 +231,8 @@ public final class Module extends Attribute { } /** + * Gets the table of required modules. + * * @return table of required modules. * @see ModuleRequires */ diff --git a/src/main/java/org/apache/bcel/classfile/ModuleExports.java b/src/main/java/org/apache/bcel/classfile/ModuleExports.java index 4b6173c3..5dcde7c5 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleExports.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleExports.java @@ -68,6 +68,8 @@ public final class ModuleExports implements Cloneable, Node { } /** + * Creates a deep copy of this object. + * * @return deep copy of this object. */ public ModuleExports copy() { @@ -139,6 +141,9 @@ public final class ModuleExports implements Cloneable, Node { } /** + * Gets the resolved string representation. + * + * @param constantPool the constant pool. * @return Resolved string representation. */ public String toString(final ConstantPool constantPool) { diff --git a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java index fba24f16..91177a69 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java @@ -51,6 +51,8 @@ public final class ModuleMainClass extends Attribute { } /** + * Constructs a new ModuleMainClass. + * * @param nameIndex Index in constant pool. * @param length Content length in bytes. * @param mainClassIndex Host class index. @@ -105,6 +107,8 @@ public final class ModuleMainClass extends Attribute { } /** + * Gets the host class index. + * * @return index into constant pool of host class name. */ public int getHostClassIndex() { @@ -112,6 +116,8 @@ public final class ModuleMainClass extends Attribute { } /** + * Sets the host class index. + * * @param mainClassIndex the host class index. */ public void setHostClassIndex(final int mainClassIndex) { diff --git a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java index 24e4c77f..57ce8b8a 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleOpens.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleOpens.java @@ -68,6 +68,8 @@ public final class ModuleOpens implements Cloneable, Node { } /** + * Creates a deep copy of this object. + * * @return deep copy of this object. */ public ModuleOpens copy() { @@ -139,6 +141,9 @@ public final class ModuleOpens implements Cloneable, Node { } /** + * Gets the resolved string representation. + * + * @param constantPool the constant pool. * @return Resolved string representation. */ public String toString(final ConstantPool constantPool) { diff --git a/src/main/java/org/apache/bcel/classfile/ModulePackages.java b/src/main/java/org/apache/bcel/classfile/ModulePackages.java index 46ac6e75..1fea7f25 100644 --- a/src/main/java/org/apache/bcel/classfile/ModulePackages.java +++ b/src/main/java/org/apache/bcel/classfile/ModulePackages.java @@ -53,6 +53,8 @@ public final class ModulePackages extends Attribute { } /** + * Constructs a new ModulePackages. + * * @param nameIndex Index in constant pool. * @param length Content length in bytes. * @param packageIndexTable Table of indices in constant pool. @@ -114,6 +116,8 @@ public final class ModulePackages extends Attribute { } /** + * Gets the number of packages. + * * @return Length of package table. */ public int getNumberOfPackages() { @@ -121,6 +125,8 @@ public final class ModulePackages extends Attribute { } /** + * Gets the package index table. + * * @return array of indices into constant pool of package names. */ public int[] getPackageIndexTable() { @@ -128,6 +134,8 @@ public final class ModulePackages extends Attribute { } /** + * Gets the package names. + * * @return string array of package names. */ public String[] getPackageNames() { @@ -137,6 +145,8 @@ public final class ModulePackages extends Attribute { } /** + * Sets the package index table. + * * @param packageIndexTable the list of package indexes Also redefines number_of_packages according to table length. */ public void setPackageIndexTable(final int[] packageIndexTable) { diff --git a/src/main/java/org/apache/bcel/classfile/ModuleProvides.java b/src/main/java/org/apache/bcel/classfile/ModuleProvides.java index 1fa1f5b8..deb7793e 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleProvides.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleProvides.java @@ -70,6 +70,8 @@ public final class ModuleProvides implements Cloneable, Node { } /** + * Creates a deep copy of this object. + * * @return deep copy of this object. */ public ModuleProvides copy() { @@ -131,6 +133,9 @@ public final class ModuleProvides implements Cloneable, Node { } /** + * Gets the resolved string representation. + * + * @param constantPool the constant pool. * @return Resolved string representation. */ public String toString(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 f512186a..8a091c63 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleRequires.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleRequires.java @@ -62,6 +62,8 @@ public final class ModuleRequires implements Cloneable, Node { } /** + * Creates a deep copy of this object. + * * @return deep copy of this object. */ public ModuleRequires copy() { @@ -126,6 +128,9 @@ public final class ModuleRequires implements Cloneable, Node { } /** + * Gets the resolved string representation. + * + * @param constantPool the constant pool. * @return Resolved string representation. */ public String toString(final ConstantPool constantPool) { diff --git a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java index 68521579..3028ccc6 100644 --- a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java +++ b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java @@ -44,6 +44,11 @@ public class INVOKEDYNAMIC extends InvokeInstruction { INVOKEDYNAMIC() { } + /** + * Constructs an INVOKEDYNAMIC instruction. + * + * @param index index into constant pool. + */ public INVOKEDYNAMIC(final int index) { super(Const.INVOKEDYNAMIC, index); } diff --git a/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java b/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java index b52e5ae7..650af627 100644 --- a/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java +++ b/src/main/java/org/apache/bcel/generic/INVOKEINTERFACE.java @@ -46,6 +46,12 @@ public final class INVOKEINTERFACE extends InvokeInstruction { INVOKEINTERFACE() { } + /** + * Constructs an INVOKEINTERFACE instruction. + * + * @param index index into constant pool. + * @param nargs number of arguments. + */ public INVOKEINTERFACE(final int index, final int nargs) { super(Const.INVOKEINTERFACE, index); super.setLength(5); @@ -94,6 +100,8 @@ public final class INVOKEINTERFACE extends InvokeInstruction { /** * The <strong>count</strong> argument according to the Java Language Specification, Second Edition. + * + * @return the count argument. */ public int getCount() { return nargs; diff --git a/src/main/java/org/apache/bcel/generic/INVOKESPECIAL.java b/src/main/java/org/apache/bcel/generic/INVOKESPECIAL.java index dc5ac116..d1b5e919 100644 --- a/src/main/java/org/apache/bcel/generic/INVOKESPECIAL.java +++ b/src/main/java/org/apache/bcel/generic/INVOKESPECIAL.java @@ -43,6 +43,11 @@ public class INVOKESPECIAL extends InvokeInstruction { INVOKESPECIAL() { } + /** + * Constructs an INVOKESPECIAL instruction. + * + * @param index index into constant pool. + */ public INVOKESPECIAL(final int index) { super(Const.INVOKESPECIAL, index); } diff --git a/src/main/java/org/apache/bcel/generic/INVOKESTATIC.java b/src/main/java/org/apache/bcel/generic/INVOKESTATIC.java index 1a803075..11522741 100644 --- a/src/main/java/org/apache/bcel/generic/INVOKESTATIC.java +++ b/src/main/java/org/apache/bcel/generic/INVOKESTATIC.java @@ -42,6 +42,11 @@ public class INVOKESTATIC extends InvokeInstruction { INVOKESTATIC() { } + /** + * Constructs an INVOKESTATIC instruction. + * + * @param index index into constant pool. + */ public INVOKESTATIC(final int index) { super(Const.INVOKESTATIC, index); } diff --git a/src/main/java/org/apache/bcel/generic/INVOKEVIRTUAL.java b/src/main/java/org/apache/bcel/generic/INVOKEVIRTUAL.java index 2cfb3925..95e23aad 100644 --- a/src/main/java/org/apache/bcel/generic/INVOKEVIRTUAL.java +++ b/src/main/java/org/apache/bcel/generic/INVOKEVIRTUAL.java @@ -42,6 +42,11 @@ public class INVOKEVIRTUAL extends InvokeInstruction { INVOKEVIRTUAL() { } + /** + * Constructs an INVOKEVIRTUAL instruction. + * + * @param index index into constant pool. + */ public INVOKEVIRTUAL(final int index) { super(Const.INVOKEVIRTUAL, index); } diff --git a/src/main/java/org/apache/bcel/generic/IOR.java b/src/main/java/org/apache/bcel/generic/IOR.java index 8ab7c818..f9897b9a 100644 --- a/src/main/java/org/apache/bcel/generic/IOR.java +++ b/src/main/java/org/apache/bcel/generic/IOR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class IOR extends ArithmeticInstruction { + /** + * Constructs an IOR instruction. + */ public IOR() { super(org.apache.bcel.Const.IOR); } diff --git a/src/main/java/org/apache/bcel/generic/ISHL.java b/src/main/java/org/apache/bcel/generic/ISHL.java index 6fd07edd..b051b7e2 100644 --- a/src/main/java/org/apache/bcel/generic/ISHL.java +++ b/src/main/java/org/apache/bcel/generic/ISHL.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class ISHL extends ArithmeticInstruction { + /** + * Constructs an ISHL instruction. + */ public ISHL() { super(org.apache.bcel.Const.ISHL); } diff --git a/src/main/java/org/apache/bcel/generic/ISHR.java b/src/main/java/org/apache/bcel/generic/ISHR.java index 5134b885..102448a1 100644 --- a/src/main/java/org/apache/bcel/generic/ISHR.java +++ b/src/main/java/org/apache/bcel/generic/ISHR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class ISHR extends ArithmeticInstruction { + /** + * Constructs an ISHR instruction. + */ public ISHR() { super(org.apache.bcel.Const.ISHR); } diff --git a/src/main/java/org/apache/bcel/generic/IUSHR.java b/src/main/java/org/apache/bcel/generic/IUSHR.java index 8645cd23..04ab9528 100644 --- a/src/main/java/org/apache/bcel/generic/IUSHR.java +++ b/src/main/java/org/apache/bcel/generic/IUSHR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class IUSHR extends ArithmeticInstruction { + /** + * Constructs an IUSHR instruction. + */ public IUSHR() { super(org.apache.bcel.Const.IUSHR); } diff --git a/src/main/java/org/apache/bcel/generic/IXOR.java b/src/main/java/org/apache/bcel/generic/IXOR.java index 5cdcd9ba..0b64b226 100644 --- a/src/main/java/org/apache/bcel/generic/IXOR.java +++ b/src/main/java/org/apache/bcel/generic/IXOR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class IXOR extends ArithmeticInstruction { + /** + * Constructs an IXOR instruction. + */ public IXOR() { super(org.apache.bcel.Const.IXOR); } diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java b/src/main/java/org/apache/bcel/generic/InstructionFactory.java index a5ed9598..37fc677c 100644 --- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java +++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java @@ -631,10 +631,11 @@ public class InstructionFactory implements InstructionConstants { /** * Create a field instruction. * - * @param className name of the accessed class. + * @param className class name containing the field. * @param name name of the referenced field. * @param type type of field. * @param kind how to access, that is, GETFIELD, PUTFIELD, GETSTATIC, PUTSTATIC. + * @return a field instruction. * @see Const */ public FieldInstruction createFieldAccess(final String className, final String name, final Type type, final short kind) { diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java b/src/main/java/org/apache/bcel/generic/InstructionList.java index 96aef77a..2e3b23a1 100644 --- a/src/main/java/org/apache/bcel/generic/InstructionList.java +++ b/src/main/java/org/apache/bcel/generic/InstructionList.java @@ -846,6 +846,8 @@ public class InstructionList implements Iterable<InstructionHandle> { /** * Tests for empty list. + * + * @return true if list is empty, false otherwise. */ public boolean isEmpty() { return start == null; diff --git a/src/main/java/org/apache/bcel/generic/JSR.java b/src/main/java/org/apache/bcel/generic/JSR.java index ba8d946d..b49b4cf1 100644 --- a/src/main/java/org/apache/bcel/generic/JSR.java +++ b/src/main/java/org/apache/bcel/generic/JSR.java @@ -32,6 +32,11 @@ public class JSR extends JsrInstruction implements VariableLengthInstruction { JSR() { } + /** + * Constructs a JSR instruction. + * + * @param target branch target. + */ public JSR(final InstructionHandle target) { super(org.apache.bcel.Const.JSR, target); } diff --git a/src/main/java/org/apache/bcel/generic/JSR_W.java b/src/main/java/org/apache/bcel/generic/JSR_W.java index 3acd7865..fa2193a6 100644 --- a/src/main/java/org/apache/bcel/generic/JSR_W.java +++ b/src/main/java/org/apache/bcel/generic/JSR_W.java @@ -34,6 +34,11 @@ public class JSR_W extends JsrInstruction { JSR_W() { } + /** + * Constructs a JSR_W instruction. + * + * @param target branch target. + */ public JSR_W(final InstructionHandle target) { super(org.apache.bcel.Const.JSR_W, target); super.setLength(5); diff --git a/src/main/java/org/apache/bcel/generic/L2D.java b/src/main/java/org/apache/bcel/generic/L2D.java index 93ec038d..0a8ba3f8 100644 --- a/src/main/java/org/apache/bcel/generic/L2D.java +++ b/src/main/java/org/apache/bcel/generic/L2D.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class L2D extends ConversionInstruction { + /** + * Constructs an L2D instruction. + */ public L2D() { super(org.apache.bcel.Const.L2D); } diff --git a/src/main/java/org/apache/bcel/generic/L2F.java b/src/main/java/org/apache/bcel/generic/L2F.java index 95beb640..7608d3d1 100644 --- a/src/main/java/org/apache/bcel/generic/L2F.java +++ b/src/main/java/org/apache/bcel/generic/L2F.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class L2F extends ConversionInstruction { + /** + * Constructs an L2F instruction. + */ public L2F() { super(org.apache.bcel.Const.L2F); } diff --git a/src/main/java/org/apache/bcel/generic/L2I.java b/src/main/java/org/apache/bcel/generic/L2I.java index fa14c8e4..95fcc882 100644 --- a/src/main/java/org/apache/bcel/generic/L2I.java +++ b/src/main/java/org/apache/bcel/generic/L2I.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class L2I extends ConversionInstruction { + /** + * Constructs an L2I instruction. + */ public L2I() { super(org.apache.bcel.Const.L2I); } diff --git a/src/main/java/org/apache/bcel/generic/LADD.java b/src/main/java/org/apache/bcel/generic/LADD.java index 251587ba..3d0c6b8c 100644 --- a/src/main/java/org/apache/bcel/generic/LADD.java +++ b/src/main/java/org/apache/bcel/generic/LADD.java @@ -29,6 +29,9 @@ package org.apache.bcel.generic; */ public class LADD extends ArithmeticInstruction { + /** + * Constructs an LADD instruction. + */ public LADD() { super(org.apache.bcel.Const.LADD); } diff --git a/src/main/java/org/apache/bcel/generic/LAND.java b/src/main/java/org/apache/bcel/generic/LAND.java index dfa54e4a..375e6bcb 100644 --- a/src/main/java/org/apache/bcel/generic/LAND.java +++ b/src/main/java/org/apache/bcel/generic/LAND.java @@ -29,6 +29,9 @@ package org.apache.bcel.generic; */ public class LAND extends ArithmeticInstruction { + /** + * Constructs an LAND instruction. + */ public LAND() { super(org.apache.bcel.Const.LAND); } diff --git a/src/main/java/org/apache/bcel/generic/LCMP.java b/src/main/java/org/apache/bcel/generic/LCMP.java index faecd83f..1768d2ae 100644 --- a/src/main/java/org/apache/bcel/generic/LCMP.java +++ b/src/main/java/org/apache/bcel/generic/LCMP.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LCMP extends Instruction implements TypedInstruction, StackProducer, StackConsumer { + /** + * Constructs an LCMP instruction. + */ public LCMP() { super(org.apache.bcel.Const.LCMP, (short) 1); } diff --git a/src/main/java/org/apache/bcel/generic/LCONST.java b/src/main/java/org/apache/bcel/generic/LCONST.java index 4ed4b21f..87537903 100644 --- a/src/main/java/org/apache/bcel/generic/LCONST.java +++ b/src/main/java/org/apache/bcel/generic/LCONST.java @@ -36,6 +36,11 @@ public class LCONST extends Instruction implements ConstantPushInstruction { this(0); } + /** + * Constructs an LCONST instruction. + * + * @param l long constant value. + */ public LCONST(final long l) { super(org.apache.bcel.Const.LCONST_0, (short) 1); if (l == 0) { diff --git a/src/main/java/org/apache/bcel/generic/LDC.java b/src/main/java/org/apache/bcel/generic/LDC.java index a46c6dc0..d84b4808 100644 --- a/src/main/java/org/apache/bcel/generic/LDC.java +++ b/src/main/java/org/apache/bcel/generic/LDC.java @@ -39,6 +39,11 @@ public class LDC extends CPInstruction implements PushInstruction, ExceptionThro LDC() { } + /** + * Constructs an LDC instruction. + * + * @param index index into constant pool. + */ public LDC(final int index) { super(org.apache.bcel.Const.LDC_W, index); setSize(); @@ -98,6 +103,12 @@ 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. + */ public Object getValue(final ConstantPoolGen cpg) { org.apache.bcel.classfile.Constant c = cpg.getConstantPool().getConstant(super.getIndex()); switch (c.getTag()) { @@ -139,7 +150,9 @@ public class LDC extends CPInstruction implements PushInstruction, ExceptionThro setSize(); } - // Adjust to proper size + /** + * Adjusts to proper size. + */ protected final void setSize() { if (super.getIndex() <= org.apache.bcel.Const.MAX_BYTE) { // Fits in one byte? super.setOpcode(org.apache.bcel.Const.LDC); 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 61cba675..ec7193d9 100644 --- a/src/main/java/org/apache/bcel/generic/LDC2_W.java +++ b/src/main/java/org/apache/bcel/generic/LDC2_W.java @@ -33,6 +33,11 @@ public class LDC2_W extends CPInstruction implements PushInstruction { LDC2_W() { } + /** + * Constructs an LDC2_W instruction. + * + * @param index index into constant pool. + */ public LDC2_W(final int index) { super(org.apache.bcel.Const.LDC2_W, index); } @@ -64,6 +69,12 @@ 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. + */ public Number getValue(final ConstantPoolGen cpg) { final org.apache.bcel.classfile.Constant c = cpg.getConstantPool().getConstant(super.getIndex()); switch (c.getTag()) { diff --git a/src/main/java/org/apache/bcel/generic/LDC_W.java b/src/main/java/org/apache/bcel/generic/LDC_W.java index 3be17d25..52600ae7 100644 --- a/src/main/java/org/apache/bcel/generic/LDC_W.java +++ b/src/main/java/org/apache/bcel/generic/LDC_W.java @@ -37,6 +37,11 @@ public class LDC_W extends LDC { LDC_W() { } + /** + * Constructs an LDC_W instruction. + * + * @param index index into constant pool. + */ public LDC_W(final int index) { super(index); } diff --git a/src/main/java/org/apache/bcel/generic/LDIV.java b/src/main/java/org/apache/bcel/generic/LDIV.java index 8bbb6b69..0f265387 100644 --- a/src/main/java/org/apache/bcel/generic/LDIV.java +++ b/src/main/java/org/apache/bcel/generic/LDIV.java @@ -31,6 +31,9 @@ import org.apache.bcel.ExceptionConst; */ public class LDIV extends ArithmeticInstruction implements ExceptionThrower { + /** + * Constructs an LDIV instruction. + */ public LDIV() { super(org.apache.bcel.Const.LDIV); } diff --git a/src/main/java/org/apache/bcel/generic/LLOAD.java b/src/main/java/org/apache/bcel/generic/LLOAD.java index d6f7b05b..7ca761b5 100644 --- a/src/main/java/org/apache/bcel/generic/LLOAD.java +++ b/src/main/java/org/apache/bcel/generic/LLOAD.java @@ -34,6 +34,11 @@ public class LLOAD extends LoadInstruction { super(org.apache.bcel.Const.LLOAD, org.apache.bcel.Const.LLOAD_0); } + /** + * Load long from local variable. + * + * @param n index of local variable. + */ public LLOAD(final int n) { super(org.apache.bcel.Const.LLOAD, org.apache.bcel.Const.LLOAD_0, n); } diff --git a/src/main/java/org/apache/bcel/generic/LMUL.java b/src/main/java/org/apache/bcel/generic/LMUL.java index 64c8e91e..d2245144 100644 --- a/src/main/java/org/apache/bcel/generic/LMUL.java +++ b/src/main/java/org/apache/bcel/generic/LMUL.java @@ -29,6 +29,9 @@ package org.apache.bcel.generic; */ public class LMUL extends ArithmeticInstruction { + /** + * Constructs an LMUL instruction. + */ public LMUL() { super(org.apache.bcel.Const.LMUL); } diff --git a/src/main/java/org/apache/bcel/generic/LNEG.java b/src/main/java/org/apache/bcel/generic/LNEG.java index 3073a1e0..5db072d9 100644 --- a/src/main/java/org/apache/bcel/generic/LNEG.java +++ b/src/main/java/org/apache/bcel/generic/LNEG.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LNEG extends ArithmeticInstruction { + /** + * Constructs an LNEG instruction. + */ public LNEG() { super(org.apache.bcel.Const.LNEG); } diff --git a/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java b/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java index c9cffa6e..dc1c8317 100644 --- a/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java +++ b/src/main/java/org/apache/bcel/generic/LOOKUPSWITCH.java @@ -36,6 +36,13 @@ public class LOOKUPSWITCH extends Select { LOOKUPSWITCH() { } + /** + * Constructs a LOOKUPSWITCH instruction. + * + * @param match array of match values. + * @param targets array of branch targets. + * @param defaultTarget default branch target. + */ public LOOKUPSWITCH(final int[] match, final InstructionHandle[] targets, final InstructionHandle defaultTarget) { super(org.apache.bcel.Const.LOOKUPSWITCH, match, targets, defaultTarget); /* alignment remainder assumed 0 here, until dump time. */ diff --git a/src/main/java/org/apache/bcel/generic/LOR.java b/src/main/java/org/apache/bcel/generic/LOR.java index d6d7ceb7..a8cdfedd 100644 --- a/src/main/java/org/apache/bcel/generic/LOR.java +++ b/src/main/java/org/apache/bcel/generic/LOR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LOR extends ArithmeticInstruction { + /** + * Constructs an LOR instruction. + */ public LOR() { super(org.apache.bcel.Const.LOR); } diff --git a/src/main/java/org/apache/bcel/generic/LREM.java b/src/main/java/org/apache/bcel/generic/LREM.java index f4943582..5ae87dcd 100644 --- a/src/main/java/org/apache/bcel/generic/LREM.java +++ b/src/main/java/org/apache/bcel/generic/LREM.java @@ -29,6 +29,9 @@ import org.apache.bcel.ExceptionConst; */ public class LREM extends ArithmeticInstruction implements ExceptionThrower { + /** + * Constructs an LREM instruction. + */ public LREM() { super(org.apache.bcel.Const.LREM); } diff --git a/src/main/java/org/apache/bcel/generic/LRETURN.java b/src/main/java/org/apache/bcel/generic/LRETURN.java index 51812db0..9a447e9f 100644 --- a/src/main/java/org/apache/bcel/generic/LRETURN.java +++ b/src/main/java/org/apache/bcel/generic/LRETURN.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LRETURN extends ReturnInstruction { + /** + * Constructs an LRETURN instruction. + */ public LRETURN() { super(org.apache.bcel.Const.LRETURN); } diff --git a/src/main/java/org/apache/bcel/generic/LSHL.java b/src/main/java/org/apache/bcel/generic/LSHL.java index 70437fed..b7eb2177 100644 --- a/src/main/java/org/apache/bcel/generic/LSHL.java +++ b/src/main/java/org/apache/bcel/generic/LSHL.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LSHL extends ArithmeticInstruction { + /** + * Constructs an LSHL instruction. + */ public LSHL() { super(org.apache.bcel.Const.LSHL); } diff --git a/src/main/java/org/apache/bcel/generic/LSHR.java b/src/main/java/org/apache/bcel/generic/LSHR.java index 61556b45..00ee22f7 100644 --- a/src/main/java/org/apache/bcel/generic/LSHR.java +++ b/src/main/java/org/apache/bcel/generic/LSHR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LSHR extends ArithmeticInstruction { + /** + * Constructs an LSHR instruction. + */ public LSHR() { super(org.apache.bcel.Const.LSHR); } diff --git a/src/main/java/org/apache/bcel/generic/LSTORE.java b/src/main/java/org/apache/bcel/generic/LSTORE.java index 6a247841..3fa4583a 100644 --- a/src/main/java/org/apache/bcel/generic/LSTORE.java +++ b/src/main/java/org/apache/bcel/generic/LSTORE.java @@ -34,6 +34,11 @@ public class LSTORE extends StoreInstruction { super(org.apache.bcel.Const.LSTORE, org.apache.bcel.Const.LSTORE_0); } + /** + * Store long into local variable. + * + * @param n index of local variable. + */ public LSTORE(final int n) { super(org.apache.bcel.Const.LSTORE, org.apache.bcel.Const.LSTORE_0, n); } diff --git a/src/main/java/org/apache/bcel/generic/LSUB.java b/src/main/java/org/apache/bcel/generic/LSUB.java index a108d5b8..8edecde1 100644 --- a/src/main/java/org/apache/bcel/generic/LSUB.java +++ b/src/main/java/org/apache/bcel/generic/LSUB.java @@ -29,6 +29,9 @@ package org.apache.bcel.generic; */ public class LSUB extends ArithmeticInstruction { + /** + * Constructs an LSUB instruction. + */ public LSUB() { super(org.apache.bcel.Const.LSUB); } diff --git a/src/main/java/org/apache/bcel/generic/LUSHR.java b/src/main/java/org/apache/bcel/generic/LUSHR.java index 8574cc5b..daa56d70 100644 --- a/src/main/java/org/apache/bcel/generic/LUSHR.java +++ b/src/main/java/org/apache/bcel/generic/LUSHR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LUSHR extends ArithmeticInstruction { + /** + * Constructs an LUSHR instruction. + */ public LUSHR() { super(org.apache.bcel.Const.LUSHR); } diff --git a/src/main/java/org/apache/bcel/generic/LXOR.java b/src/main/java/org/apache/bcel/generic/LXOR.java index 820e01a2..928ac48f 100644 --- a/src/main/java/org/apache/bcel/generic/LXOR.java +++ b/src/main/java/org/apache/bcel/generic/LXOR.java @@ -27,6 +27,9 @@ package org.apache.bcel.generic; */ public class LXOR extends ArithmeticInstruction { + /** + * Constructs an LXOR instruction. + */ public LXOR() { super(org.apache.bcel.Const.LXOR); } diff --git a/src/main/java/org/apache/bcel/generic/LineNumberGen.java b/src/main/java/org/apache/bcel/generic/LineNumberGen.java index c644d424..76e6e3ed 100644 --- a/src/main/java/org/apache/bcel/generic/LineNumberGen.java +++ b/src/main/java/org/apache/bcel/generic/LineNumberGen.java @@ -40,6 +40,7 @@ public class LineNumberGen implements InstructionTargeter, Cloneable { * Create a line number. * * @param ih instruction handle to reference. + * @param srcLine source line number. */ public LineNumberGen(final InstructionHandle ih, final int srcLine) { setInstruction(ih); @@ -63,6 +64,11 @@ public class LineNumberGen implements InstructionTargeter, Cloneable { return this.ih == ih; } + /** + * Gets the instruction handle. + * + * @return the instruction handle. + */ public InstructionHandle getInstruction() { return ih; } @@ -72,21 +78,38 @@ 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. */ public LineNumber getLineNumber() { return new LineNumber(ih.getPosition(), srcLine); } + /** + * Gets the source line number. + * + * @return the source line number. + */ public int getSourceLine() { return srcLine; } + /** + * Sets the instruction handle. + * + * @param instructionHandle the instruction handle to set. + */ public void setInstruction(final InstructionHandle instructionHandle) { // TODO could be package-protected? Objects.requireNonNull(instructionHandle, "instructionHandle"); BranchInstruction.notifyTarget(this.ih, instructionHandle, this); this.ih = instructionHandle; } + /** + * Sets the source line number. + * + * @param srcLine the source line number to set. + */ public void setSourceLine(final int srcLine) { // TODO could be package-protected? this.srcLine = srcLine; } diff --git a/src/main/java/org/apache/bcel/generic/MONITORENTER.java b/src/main/java/org/apache/bcel/generic/MONITORENTER.java index 9df98a61..78ab9453 100644 --- a/src/main/java/org/apache/bcel/generic/MONITORENTER.java +++ b/src/main/java/org/apache/bcel/generic/MONITORENTER.java @@ -29,6 +29,9 @@ import org.apache.bcel.ExceptionConst; */ public class MONITORENTER extends Instruction implements ExceptionThrower, StackConsumer { + /** + * Constructs a MONITORENTER instruction. + */ public MONITORENTER() { super(org.apache.bcel.Const.MONITORENTER, (short) 1); } diff --git a/src/main/java/org/apache/bcel/generic/MONITOREXIT.java b/src/main/java/org/apache/bcel/generic/MONITOREXIT.java index fe92e803..232cd57a 100644 --- a/src/main/java/org/apache/bcel/generic/MONITOREXIT.java +++ b/src/main/java/org/apache/bcel/generic/MONITOREXIT.java @@ -29,6 +29,9 @@ import org.apache.bcel.ExceptionConst; */ public class MONITOREXIT extends Instruction implements ExceptionThrower, StackConsumer { + /** + * Constructs a MONITOREXIT instruction. + */ public MONITOREXIT() { super(org.apache.bcel.Const.MONITOREXIT, (short) 1); } diff --git a/src/main/java/org/apache/bcel/generic/MethodObserver.java b/src/main/java/org/apache/bcel/generic/MethodObserver.java index edd2a520..c339bbae 100644 --- a/src/main/java/org/apache/bcel/generic/MethodObserver.java +++ b/src/main/java/org/apache/bcel/generic/MethodObserver.java @@ -24,5 +24,10 @@ package org.apache.bcel.generic; */ public interface MethodObserver { + /** + * Notifies this observer of a change to the method. + * + * @param method the method that changed. + */ void notify(MethodGen method); } diff --git a/src/main/java/org/apache/bcel/generic/Select.java b/src/main/java/org/apache/bcel/generic/Select.java index 8b0dc3e1..5aaf7bb3 100644 --- a/src/main/java/org/apache/bcel/generic/Select.java +++ b/src/main/java/org/apache/bcel/generic/Select.java @@ -160,6 +160,8 @@ public abstract class Select extends BranchInstruction implements VariableLength } /** + * Gets the match target offsets. + * * @return array of match target offsets. */ public int[] getIndices() { @@ -191,6 +193,8 @@ public abstract class Select extends BranchInstruction implements VariableLength } /** + * Gets the match indices. + * * @return array of match indices. */ public int[] getMatchs() { @@ -215,6 +219,8 @@ public abstract class Select extends BranchInstruction implements VariableLength } /** + * Gets the match targets. + * * @return array of match targets. */ public InstructionHandle[] getTargets() { @@ -286,7 +292,10 @@ public abstract class Select extends BranchInstruction implements VariableLength } /** - * Sets branch target for 'i'th case + * Sets branch target for 'i'th case. + * + * @param i the case index. + * @param target the branch target. */ public void setTarget(final int i, final InstructionHandle target) { // TODO could be package-protected? notifyTarget(targets[i], target, this); diff --git a/src/main/java/org/apache/bcel/util/JavaWrapper.java b/src/main/java/org/apache/bcel/util/JavaWrapper.java index 2e7cbb2b..ad56ecf1 100644 --- a/src/main/java/org/apache/bcel/util/JavaWrapper.java +++ b/src/main/java/org/apache/bcel/util/JavaWrapper.java @@ -59,6 +59,9 @@ public class JavaWrapper { /** * Default main method used as wrapper, expects the fully qualified class name of the real class as the first argument. + * + * @param argv command line arguments where first argument is the class name. + * @throws Exception if an error occurs during execution. */ public static void main(final String[] argv) throws Exception { /* @@ -76,10 +79,18 @@ public class JavaWrapper { private final java.lang.ClassLoader loader; + /** + * Constructs a JavaWrapper with the default class loader. + */ public JavaWrapper() { this(getClassLoader()); } + /** + * Constructs a JavaWrapper with the specified class loader. + * + * @param loader the class loader to use. + */ public JavaWrapper(final java.lang.ClassLoader loader) { this.loader = loader; } diff --git a/src/main/java/org/apache/bcel/util/LruCacheClassPathRepository.java b/src/main/java/org/apache/bcel/util/LruCacheClassPathRepository.java index 9074925b..beb3ce06 100644 --- a/src/main/java/org/apache/bcel/util/LruCacheClassPathRepository.java +++ b/src/main/java/org/apache/bcel/util/LruCacheClassPathRepository.java @@ -37,6 +37,12 @@ public class LruCacheClassPathRepository extends AbstractClassPathRepository { private final LinkedHashMap<String, JavaClass> loadedClasses; + /** + * Constructs a new LruCacheClassPathRepository. + * + * @param path the class path. + * @param cacheSize the cache size. + */ public LruCacheClassPathRepository(final ClassPath path, final int cacheSize) { super(path); diff --git a/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java b/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java index 56f3539c..1c830b00 100644 --- a/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java +++ b/src/main/java/org/apache/bcel/util/MemorySensitiveClassPathRepository.java @@ -36,6 +36,11 @@ public class MemorySensitiveClassPathRepository extends AbstractClassPathReposit private final Map<String, SoftReference<JavaClass>> loadedClasses = new HashMap<>(); // CLASSNAME X JAVACLASS + /** + * Constructs a new MemorySensitiveClassPathRepository. + * + * @param path the class path. + */ public MemorySensitiveClassPathRepository(final ClassPath path) { super(path); } diff --git a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java index 0dd666e9..612c3fa6 100644 --- a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java +++ b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java @@ -89,6 +89,11 @@ public class ModularRuntimeImage implements Closeable { } } + /** + * Gets the file system. + * + * @return the file system. + */ public FileSystem getFileSystem() { return fileSystem; } diff --git a/src/main/java/org/apache/bcel/verifier/exc/InvalidMethodException.java b/src/main/java/org/apache/bcel/verifier/exc/InvalidMethodException.java index 1bd91126..917de76d 100644 --- a/src/main/java/org/apache/bcel/verifier/exc/InvalidMethodException.java +++ b/src/main/java/org/apache/bcel/verifier/exc/InvalidMethodException.java @@ -26,7 +26,11 @@ public class InvalidMethodException extends RuntimeException { private static final long serialVersionUID = -7060302743724808051L; - /** Constructs an InvalidMethodException with the specified detail message. */ + /** + * Constructs an InvalidMethodException with the specified detail message. + * + * @param message the detail message. + */ public InvalidMethodException(final String message) { super(message); } diff --git a/src/main/java/org/apache/bcel/verifier/exc/LinkingConstraintException.java b/src/main/java/org/apache/bcel/verifier/exc/LinkingConstraintException.java index 66fecdf2..8818e971 100644 --- a/src/main/java/org/apache/bcel/verifier/exc/LinkingConstraintException.java +++ b/src/main/java/org/apache/bcel/verifier/exc/LinkingConstraintException.java @@ -31,4 +31,10 @@ package org.apache.bcel.verifier.exc; public class LinkingConstraintException extends StructuralCodeConstraintException { private static final long serialVersionUID = -5239226345026321126L; + + /** + * Constructs a new LinkingConstraintException. + */ + public LinkingConstraintException() { + } } diff --git a/src/main/java/org/apache/bcel/verifier/exc/LoadingException.java b/src/main/java/org/apache/bcel/verifier/exc/LoadingException.java index 1647df30..0fd435c0 100644 --- a/src/main/java/org/apache/bcel/verifier/exc/LoadingException.java +++ b/src/main/java/org/apache/bcel/verifier/exc/LoadingException.java @@ -35,6 +35,8 @@ public class LoadingException extends VerifierConstraintViolatedException { /** * Constructs a new LoadingException with the specified error message. + * + * @param message the error message. */ public LoadingException(final String message) { super(message); diff --git a/src/main/java/org/apache/bcel/verifier/exc/LocalVariableInfoInconsistentException.java b/src/main/java/org/apache/bcel/verifier/exc/LocalVariableInfoInconsistentException.java index 2e1c38a1..6567b01b 100644 --- a/src/main/java/org/apache/bcel/verifier/exc/LocalVariableInfoInconsistentException.java +++ b/src/main/java/org/apache/bcel/verifier/exc/LocalVariableInfoInconsistentException.java @@ -34,6 +34,8 @@ public class LocalVariableInfoInconsistentException extends ClassConstraintExcep /** * Constructs a new LocalVariableInfoInconsistentException with the specified error message. + * + * @param message the error message. */ public LocalVariableInfoInconsistentException(final String message) { super(message); diff --git a/src/main/java/org/apache/bcel/verifier/exc/StructuralCodeConstraintException.java b/src/main/java/org/apache/bcel/verifier/exc/StructuralCodeConstraintException.java index b508ecba..8f5e089a 100644 --- a/src/main/java/org/apache/bcel/verifier/exc/StructuralCodeConstraintException.java +++ b/src/main/java/org/apache/bcel/verifier/exc/StructuralCodeConstraintException.java @@ -37,6 +37,8 @@ public class StructuralCodeConstraintException extends CodeConstraintException { /** * Constructs a new StructuralCodeConstraintException with the specified error message. + * + * @param message the error message. */ public StructuralCodeConstraintException(final String message) { super(message); 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 6c020936..b9cf33a1 100644 --- a/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java +++ b/src/main/java/org/apache/bcel/verifier/statics/LocalVariableInfo.java @@ -35,6 +35,12 @@ public class LocalVariableInfo { /** The names database. KEY: String representing the offset integer. */ private final Hashtable<String, String> names = new Hashtable<>(); + /** + * Constructs a new LocalVariableInfo. + */ + public LocalVariableInfo() { + } + /** * Adds information about name and type for a given offset. *
