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 2330505d8d7dcebeb6d3bff67c0854fd0e947b9a Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Mon Aug 15 15:27:10 2022 -0400 Fix some Javadoc warnings --- .../org/apache/bcel/classfile/BootstrapMethod.java | 4 +-- .../apache/bcel/classfile/BootstrapMethods.java | 4 +-- .../bcel/classfile/ClassFormatException.java | 7 ++-- .../org/apache/bcel/classfile/ClassParser.java | 38 +++++++++++----------- src/main/java/org/apache/bcel/classfile/Code.java | 2 +- .../org/apache/bcel/classfile/CodeException.java | 4 +-- .../java/org/apache/bcel/classfile/ConstantCP.java | 4 +-- .../org/apache/bcel/classfile/ConstantDouble.java | 4 +-- .../org/apache/bcel/classfile/ConstantDynamic.java | 2 +- .../apache/bcel/classfile/ConstantFieldref.java | 2 +- .../org/apache/bcel/classfile/ConstantFloat.java | 4 +-- .../org/apache/bcel/classfile/ConstantInteger.java | 4 +-- .../bcel/classfile/ConstantInterfaceMethodref.java | 2 +- .../bcel/classfile/ConstantInvokeDynamic.java | 2 +- .../org/apache/bcel/classfile/ConstantLong.java | 4 +-- .../bcel/classfile/ConstantMethodHandle.java | 4 +-- .../apache/bcel/classfile/ConstantMethodType.java | 4 +-- .../apache/bcel/classfile/ConstantMethodref.java | 2 +- .../org/apache/bcel/classfile/ConstantModule.java | 4 +-- .../apache/bcel/classfile/ConstantNameAndType.java | 4 +-- .../org/apache/bcel/classfile/ConstantPackage.java | 4 +-- .../org/apache/bcel/classfile/ConstantPool.java | 2 +- .../org/apache/bcel/classfile/ConstantString.java | 4 +-- .../org/apache/bcel/classfile/ConstantUtf8.java | 4 +-- .../org/apache/bcel/classfile/ConstantValue.java | 4 +-- .../java/org/apache/bcel/classfile/Deprecated.java | 2 +- .../org/apache/bcel/classfile/ExceptionTable.java | 2 +- .../java/org/apache/bcel/classfile/InnerClass.java | 4 +-- .../org/apache/bcel/classfile/InnerClasses.java | 4 +-- .../java/org/apache/bcel/classfile/JavaClass.java | 8 ++--- .../org/apache/bcel/classfile/LocalVariable.java | 2 +- .../apache/bcel/classfile/LocalVariableTable.java | 4 +-- .../java/org/apache/bcel/classfile/Method.java | 4 +-- .../org/apache/bcel/classfile/MethodParameter.java | 6 ++-- .../apache/bcel/classfile/MethodParameters.java | 2 +- .../java/org/apache/bcel/classfile/Module.java | 4 +-- .../org/apache/bcel/classfile/ModuleMainClass.java | 2 +- .../org/apache/bcel/classfile/ModulePackages.java | 4 +-- .../java/org/apache/bcel/classfile/NestHost.java | 2 +- .../org/apache/bcel/classfile/NestMembers.java | 4 +-- .../java/org/apache/bcel/classfile/PMGClass.java | 4 +-- .../bcel/classfile/ParameterAnnotationEntry.java | 2 +- .../java/org/apache/bcel/classfile/Signature.java | 4 +-- .../java/org/apache/bcel/classfile/SourceFile.java | 4 +-- .../java/org/apache/bcel/classfile/StackMap.java | 4 +-- .../org/apache/bcel/classfile/StackMapEntry.java | 4 +-- .../org/apache/bcel/classfile/StackMapType.java | 4 +-- .../java/org/apache/bcel/classfile/Synthetic.java | 4 +-- .../java/org/apache/bcel/classfile/Unknown.java | 4 +-- .../java/org/apache/bcel/classfile/Utility.java | 12 +++---- 50 files changed, 110 insertions(+), 113 deletions(-) diff --git a/src/main/java/org/apache/bcel/classfile/BootstrapMethod.java b/src/main/java/org/apache/bcel/classfile/BootstrapMethod.java index dec65a9c..6b744e4b 100644 --- a/src/main/java/org/apache/bcel/classfile/BootstrapMethod.java +++ b/src/main/java/org/apache/bcel/classfile/BootstrapMethod.java @@ -53,7 +53,7 @@ public class BootstrapMethod implements Cloneable { * Construct object from input stream. * * @param input Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ BootstrapMethod(final DataInput input) throws IOException { this(input.readUnsignedShort(), input.readUnsignedShort()); @@ -93,7 +93,7 @@ public class BootstrapMethod implements Cloneable { * Dump object to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public final void dump(final DataOutputStream file) throws IOException { file.writeShort(bootstrapMethodRef); diff --git a/src/main/java/org/apache/bcel/classfile/BootstrapMethods.java b/src/main/java/org/apache/bcel/classfile/BootstrapMethods.java index ab16e1ca..4cffcd85 100644 --- a/src/main/java/org/apache/bcel/classfile/BootstrapMethods.java +++ b/src/main/java/org/apache/bcel/classfile/BootstrapMethods.java @@ -61,7 +61,7 @@ public class BootstrapMethods extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ BootstrapMethods(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, (BootstrapMethod[]) null, constant_pool); @@ -100,7 +100,7 @@ public class BootstrapMethods extends Attribute { * Dump bootstrap methods attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public final void dump(final DataOutputStream file) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ClassFormatException.java b/src/main/java/org/apache/bcel/classfile/ClassFormatException.java index 936f292a..90e94196 100644 --- a/src/main/java/org/apache/bcel/classfile/ClassFormatException.java +++ b/src/main/java/org/apache/bcel/classfile/ClassFormatException.java @@ -18,10 +18,8 @@ package org.apache.bcel.classfile; /** - * Thrown when the BCEL attempts to read a class file and determines - * that the file is malformed or otherwise cannot be interpreted as a - * class file. - * + * Thrown when the BCEL attempts to read a class file and determines that a class is malformed or otherwise cannot be + * interpreted as a class file. */ public class ClassFormatException extends RuntimeException { @@ -30,7 +28,6 @@ public class ClassFormatException extends RuntimeException { public ClassFormatException() { } - public ClassFormatException(final String s) { super(s); } diff --git a/src/main/java/org/apache/bcel/classfile/ClassParser.java b/src/main/java/org/apache/bcel/classfile/ClassParser.java index b49c2c4b..d284b105 100644 --- a/src/main/java/org/apache/bcel/classfile/ClassParser.java +++ b/src/main/java/org/apache/bcel/classfile/ClassParser.java @@ -111,8 +111,8 @@ public final class ClassParser { * is performed by the java interpreter). * * @return Class object representing the parsed class file - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public JavaClass parse() throws IOException, ClassFormatException { ZipFile zip = null; @@ -195,8 +195,8 @@ public final class ClassParser { /** * Reads information about the attributes of the class. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readAttributes() throws IOException, ClassFormatException { final int attributes_count = dataInputStream.readUnsignedShort(); @@ -209,8 +209,8 @@ public final class ClassParser { /** * Reads information about the class and its super class. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readClassInfo() throws IOException, ClassFormatException { accessFlags = dataInputStream.readUnsignedShort(); @@ -231,8 +231,8 @@ public final class ClassParser { /** * Reads constant pool entries. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readConstantPool() throws IOException, ClassFormatException { constantPool = new ConstantPool(dataInputStream); @@ -241,8 +241,8 @@ public final class ClassParser { /** * Reads information about the fields of the class, i.e., its variables. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readFields() throws IOException, ClassFormatException { final int fields_count = dataInputStream.readUnsignedShort(); @@ -257,8 +257,8 @@ public final class ClassParser { /** * Checks whether the header of the file is ok. * Of course, this has to be the first action on successive file reads. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readID() throws IOException, ClassFormatException { if (dataInputStream.readInt() != Const.JVM_CLASSFILE_MAGIC) { @@ -269,8 +269,8 @@ public final class ClassParser { /** * Reads information about the interfaces implemented by this class. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readInterfaces() throws IOException, ClassFormatException { final int interfaces_count = dataInputStream.readUnsignedShort(); @@ -283,10 +283,10 @@ public final class ClassParser { /** * Reads information about the methods of the class. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ - private void readMethods() throws IOException, ClassFormatException { + private void readMethods() throws IOException { final int methods_count = dataInputStream.readUnsignedShort(); methods = new Method[methods_count]; for (int i = 0; i < methods_count; i++) { @@ -297,8 +297,8 @@ public final class ClassParser { /** * Reads major and minor version of compiler which created the file. - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ private void readVersion() throws IOException, ClassFormatException { minor = dataInputStream.readUnsignedShort(); diff --git a/src/main/java/org/apache/bcel/classfile/Code.java b/src/main/java/org/apache/bcel/classfile/Code.java index 7bdd0a2d..eaf5daf5 100644 --- a/src/main/java/org/apache/bcel/classfile/Code.java +++ b/src/main/java/org/apache/bcel/classfile/Code.java @@ -177,7 +177,7 @@ public final class Code extends Attribute { * Dump code attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/CodeException.java b/src/main/java/org/apache/bcel/classfile/CodeException.java index 8181f004..75c31a3a 100644 --- a/src/main/java/org/apache/bcel/classfile/CodeException.java +++ b/src/main/java/org/apache/bcel/classfile/CodeException.java @@ -60,7 +60,7 @@ public final class CodeException implements Cloneable, Node, Constants { /** * Construct object from file stream. * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ CodeException(final DataInput file) throws IOException { this(file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), file @@ -116,7 +116,7 @@ public final class CodeException implements Cloneable, Node, Constants { * Dump code exception to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final DataOutputStream file ) throws IOException { file.writeShort(startPc); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantCP.java b/src/main/java/org/apache/bcel/classfile/ConstantCP.java index f83d76b7..38a00a08 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantCP.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantCP.java @@ -57,7 +57,7 @@ public abstract class ConstantCP extends Constant { * * @param tag Constant type tag * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantCP(final byte tag, final DataInput file) throws IOException { this(tag, file.readUnsignedShort(), file.readUnsignedShort()); @@ -87,7 +87,7 @@ public abstract class ConstantCP extends Constant { * Dump constant field reference to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public final void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantDouble.java b/src/main/java/org/apache/bcel/classfile/ConstantDouble.java index 6267f944..684c3fb6 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantDouble.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantDouble.java @@ -46,7 +46,7 @@ public final class ConstantDouble extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantDouble(final DataInput file) throws IOException { this(file.readDouble()); @@ -79,7 +79,7 @@ public final class ConstantDouble extends Constant implements ConstantObject { * Dump constant double to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java b/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java index b76db6dc..01bb168a 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantDynamic.java @@ -45,7 +45,7 @@ public final class ConstantDynamic extends ConstantCP { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantDynamic(final DataInput file) throws IOException { this(file.readShort(), file.readShort()); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java b/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java index 2c4e89d1..3d505f2a 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantFieldref.java @@ -40,7 +40,7 @@ public final class ConstantFieldref extends ConstantCP { * Initialize instance from input data. * * @param input input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantFieldref(final DataInput input) throws IOException { super(Const.CONSTANT_Fieldref, input); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantFloat.java b/src/main/java/org/apache/bcel/classfile/ConstantFloat.java index c5b3e7b3..f702e916 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantFloat.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantFloat.java @@ -47,7 +47,7 @@ public final class ConstantFloat extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantFloat(final DataInput file) throws IOException { this(file.readFloat()); @@ -80,7 +80,7 @@ public final class ConstantFloat extends Constant implements ConstantObject { * Dump constant float to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantInteger.java b/src/main/java/org/apache/bcel/classfile/ConstantInteger.java index 7769913e..ca4f7eb7 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantInteger.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantInteger.java @@ -46,7 +46,7 @@ public final class ConstantInteger extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantInteger(final DataInput file) throws IOException { this(file.readInt()); @@ -79,7 +79,7 @@ public final class ConstantInteger extends Constant implements ConstantObject { * Dump constant integer to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java b/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java index b1c668a5..bed49995 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantInterfaceMethodref.java @@ -40,7 +40,7 @@ public final class ConstantInterfaceMethodref extends ConstantCP { * Initialize instance from input data. * * @param input input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantInterfaceMethodref(final DataInput input) throws IOException { super(Const.CONSTANT_InterfaceMethodref, input); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java b/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java index 830276ec..b3877ad2 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantInvokeDynamic.java @@ -45,7 +45,7 @@ public final class ConstantInvokeDynamic extends ConstantCP { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantInvokeDynamic(final DataInput file) throws IOException { this(file.readShort(), file.readShort()); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantLong.java b/src/main/java/org/apache/bcel/classfile/ConstantLong.java index b2981a16..0342db4f 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantLong.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantLong.java @@ -46,7 +46,7 @@ public final class ConstantLong extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantLong(final DataInput file) throws IOException { this(file.readLong()); @@ -79,7 +79,7 @@ public final class ConstantLong extends Constant implements ConstantObject { * Dump constant long to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java index 524be707..8908fed7 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodHandle.java @@ -48,7 +48,7 @@ public final class ConstantMethodHandle extends Constant { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantMethodHandle(final DataInput file) throws IOException { this(file.readUnsignedByte(), file.readUnsignedShort()); @@ -79,7 +79,7 @@ public final class ConstantMethodHandle extends Constant { * Dump method kind and index to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java index d687e6ec..244c3a27 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodType.java @@ -47,7 +47,7 @@ public final class ConstantMethodType extends Constant { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantMethodType(final DataInput file) throws IOException { this(file.readUnsignedShort()); @@ -77,7 +77,7 @@ public final class ConstantMethodType extends Constant { * Dump name and signature index to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java b/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java index 0e1e628d..0cefd9f9 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantMethodref.java @@ -40,7 +40,7 @@ public final class ConstantMethodref extends ConstantCP { * Initialize instance from input data. * * @param input input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantMethodref(final DataInput input) throws IOException { super(Const.CONSTANT_Methodref, input); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantModule.java b/src/main/java/org/apache/bcel/classfile/ConstantModule.java index 53646d3f..e883a30c 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantModule.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantModule.java @@ -49,7 +49,7 @@ public final class ConstantModule extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantModule(final DataInput file) throws IOException { this(file.readUnsignedShort()); @@ -83,7 +83,7 @@ public final class ConstantModule extends Constant implements ConstantObject { * Dump constant module to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java b/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java index b8f8bf5f..2a448308 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantNameAndType.java @@ -48,7 +48,7 @@ public final class ConstantNameAndType extends Constant { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantNameAndType(final DataInput file) throws IOException { this(file.readUnsignedShort(), file.readUnsignedShort()); @@ -83,7 +83,7 @@ public final class ConstantNameAndType extends Constant { * Dump name and signature index to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantPackage.java b/src/main/java/org/apache/bcel/classfile/ConstantPackage.java index 54ae7288..4cc9ebad 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantPackage.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantPackage.java @@ -49,7 +49,7 @@ public final class ConstantPackage extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantPackage(final DataInput file) throws IOException { this(file.readUnsignedShort()); @@ -83,7 +83,7 @@ public final class ConstantPackage extends Constant implements ConstantObject { * Dump constant package to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantPool.java b/src/main/java/org/apache/bcel/classfile/ConstantPool.java index b0531cfc..f75d5b9c 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantPool.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantPool.java @@ -279,7 +279,7 @@ public class ConstantPool implements Cloneable, Node { * @param tag Tag of expected constant, i.e., its type * @return Constant value * @see Constant - * @throws ClassFormatException if constant type does not match tag + * @throws ClassFormatException if constant type does not match tag */ public Constant getConstant( final int index, final byte tag ) throws ClassFormatException { final Constant c = getConstant(index); diff --git a/src/main/java/org/apache/bcel/classfile/ConstantString.java b/src/main/java/org/apache/bcel/classfile/ConstantString.java index f77a96b2..9d2320b6 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantString.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantString.java @@ -46,7 +46,7 @@ public final class ConstantString extends Constant implements ConstantObject { * Initialize instance from file data. * * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantString(final DataInput file) throws IOException { this(file.readUnsignedShort()); @@ -79,7 +79,7 @@ public final class ConstantString extends Constant implements ConstantObject { * Dump constant field reference to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java index aa3d97db..9ba8d6df 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java @@ -194,7 +194,7 @@ public final class ConstantUtf8 extends Constant { * Initializes instance from file data. * * @param dataInput Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantUtf8(final DataInput dataInput) throws IOException { super(Const.CONSTANT_Utf8); @@ -226,7 +226,7 @@ public final class ConstantUtf8 extends Constant { * Dumps String in Utf8 format to file stream. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump(final DataOutputStream file) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ConstantValue.java b/src/main/java/org/apache/bcel/classfile/ConstantValue.java index cb46b524..3b822bde 100644 --- a/src/main/java/org/apache/bcel/classfile/ConstantValue.java +++ b/src/main/java/org/apache/bcel/classfile/ConstantValue.java @@ -50,7 +50,7 @@ public final class ConstantValue extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ ConstantValue(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -99,7 +99,7 @@ public final class ConstantValue extends Attribute { * Dump constant value attribute to file stream on binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/Deprecated.java b/src/main/java/org/apache/bcel/classfile/Deprecated.java index 24e8da9b..f744a1ea 100644 --- a/src/main/java/org/apache/bcel/classfile/Deprecated.java +++ b/src/main/java/org/apache/bcel/classfile/Deprecated.java @@ -63,7 +63,7 @@ public final class Deprecated extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ Deprecated(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ExceptionTable.java b/src/main/java/org/apache/bcel/classfile/ExceptionTable.java index ae8cf78d..fe4a4cc7 100644 --- a/src/main/java/org/apache/bcel/classfile/ExceptionTable.java +++ b/src/main/java/org/apache/bcel/classfile/ExceptionTable.java @@ -52,7 +52,7 @@ public final class ExceptionTable extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constantPool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ ExceptionTable(final int nameIndex, final int length, final DataInput input, final ConstantPool constantPool) throws IOException { this(nameIndex, length, (int[]) null, constantPool); diff --git a/src/main/java/org/apache/bcel/classfile/InnerClass.java b/src/main/java/org/apache/bcel/classfile/InnerClass.java index c76cce1e..27c8c642 100644 --- a/src/main/java/org/apache/bcel/classfile/InnerClass.java +++ b/src/main/java/org/apache/bcel/classfile/InnerClass.java @@ -41,7 +41,7 @@ public final class InnerClass implements Cloneable, Node { /** * Construct object from file stream. * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ InnerClass(final DataInput file) throws IOException { this(file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), file @@ -103,7 +103,7 @@ public final class InnerClass implements Cloneable, Node { * Dump inner class attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final DataOutputStream file ) throws IOException { file.writeShort(innerClassIndex); diff --git a/src/main/java/org/apache/bcel/classfile/InnerClasses.java b/src/main/java/org/apache/bcel/classfile/InnerClasses.java index 97383bac..40f5c508 100644 --- a/src/main/java/org/apache/bcel/classfile/InnerClasses.java +++ b/src/main/java/org/apache/bcel/classfile/InnerClasses.java @@ -57,7 +57,7 @@ public final class InnerClasses extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ InnerClasses(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -116,7 +116,7 @@ public final class InnerClasses extends Attribute { * Dump source file attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java b/src/main/java/org/apache/bcel/classfile/JavaClass.java index e744af16..50fda405 100644 --- a/src/main/java/org/apache/bcel/classfile/JavaClass.java +++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java @@ -323,7 +323,7 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl * Dump Java class to output stream in binary format. * * @param file Output stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final DataOutputStream file ) throws IOException { file.writeInt(Const.JVM_CLASSFILE_MAGIC); @@ -360,7 +360,7 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl * Dump class to a file. * * @param file Output file - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump(final File file) throws IOException { final String parent = file.getParent(); @@ -380,7 +380,7 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl * Dump Java class to output stream in binary format. * * @param file Output stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final OutputStream file ) throws IOException { dump(new DataOutputStream(file)); @@ -391,7 +391,7 @@ public class JavaClass extends AccessFlags implements Cloneable, Node, Comparabl * Dump class to a file named fileName. * * @param _file_name Output file name - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final String _file_name ) throws IOException { dump(new File(_file_name)); diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariable.java b/src/main/java/org/apache/bcel/classfile/LocalVariable.java index 2963cd6c..c5f824a3 100644 --- a/src/main/java/org/apache/bcel/classfile/LocalVariable.java +++ b/src/main/java/org/apache/bcel/classfile/LocalVariable.java @@ -55,7 +55,7 @@ public final class LocalVariable implements Cloneable, Node, Constants { /** * Constructs object from file stream. * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ LocalVariable(final DataInput file, final ConstantPool constant_pool) throws IOException { this(file.readUnsignedShort(), file.readUnsignedShort(), file.readUnsignedShort(), file diff --git a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java index 8fa6767c..1eb6e2c4 100644 --- a/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java +++ b/src/main/java/org/apache/bcel/classfile/LocalVariableTable.java @@ -41,7 +41,7 @@ public class LocalVariableTable extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ LocalVariableTable(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -108,7 +108,7 @@ public class LocalVariableTable extends Attribute { * Dump local variable table attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public final void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/Method.java b/src/main/java/org/apache/bcel/classfile/Method.java index 1b3010b6..275dd206 100644 --- a/src/main/java/org/apache/bcel/classfile/Method.java +++ b/src/main/java/org/apache/bcel/classfile/Method.java @@ -93,8 +93,8 @@ public final class Method extends FieldOrMethod { /** * Construct object from file stream. * @param file Input stream - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ Method(final DataInput file, final ConstantPool constant_pool) throws IOException, ClassFormatException { diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameter.java b/src/main/java/org/apache/bcel/classfile/MethodParameter.java index a52dd76b..6f6fa4b7 100644 --- a/src/main/java/org/apache/bcel/classfile/MethodParameter.java +++ b/src/main/java/org/apache/bcel/classfile/MethodParameter.java @@ -45,8 +45,8 @@ public class MethodParameter implements Cloneable { * Construct object from input stream. * * @param input Input stream - * @throws IOException - * @throws ClassFormatException + * @throws IOException if an I/O error occurs. + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ MethodParameter(final DataInput input) throws IOException { nameIndex = input.readUnsignedShort(); @@ -73,7 +73,7 @@ public class MethodParameter implements Cloneable { * Dump object to file stream on binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public final void dump(final DataOutputStream file) throws IOException { file.writeShort(nameIndex); diff --git a/src/main/java/org/apache/bcel/classfile/MethodParameters.java b/src/main/java/org/apache/bcel/classfile/MethodParameters.java index 5655fab9..5cd59242 100644 --- a/src/main/java/org/apache/bcel/classfile/MethodParameters.java +++ b/src/main/java/org/apache/bcel/classfile/MethodParameters.java @@ -70,7 +70,7 @@ public class MethodParameters extends Attribute { * Dump method parameters attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump(final DataOutputStream file) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/Module.java b/src/main/java/org/apache/bcel/classfile/Module.java index 76cbd77f..08604c24 100644 --- a/src/main/java/org/apache/bcel/classfile/Module.java +++ b/src/main/java/org/apache/bcel/classfile/Module.java @@ -49,7 +49,7 @@ public final class Module extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ Module(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { super(Const.ATTR_MODULE, name_index, length, constant_pool); @@ -140,7 +140,7 @@ public final class Module extends Attribute { * Dump Module attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java index c9dd9496..7841c67d 100644 --- a/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java +++ b/src/main/java/org/apache/bcel/classfile/ModuleMainClass.java @@ -40,7 +40,7 @@ public final class ModuleMainClass extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constantPool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ ModuleMainClass(final int nameIndex, final int length, final DataInput input, final ConstantPool constantPool) throws IOException { this(nameIndex, length, 0, constantPool); diff --git a/src/main/java/org/apache/bcel/classfile/ModulePackages.java b/src/main/java/org/apache/bcel/classfile/ModulePackages.java index b7b0aff3..7b3b2e6b 100644 --- a/src/main/java/org/apache/bcel/classfile/ModulePackages.java +++ b/src/main/java/org/apache/bcel/classfile/ModulePackages.java @@ -41,7 +41,7 @@ public final class ModulePackages extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ ModulePackages(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, (int[]) null, constant_pool); @@ -108,7 +108,7 @@ public final class ModulePackages extends Attribute { * Dump ModulePackages attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/NestHost.java b/src/main/java/org/apache/bcel/classfile/NestHost.java index 0f844c68..5c3a10c8 100644 --- a/src/main/java/org/apache/bcel/classfile/NestHost.java +++ b/src/main/java/org/apache/bcel/classfile/NestHost.java @@ -41,7 +41,7 @@ public final class NestHost extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ NestHost(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, 0, constant_pool); diff --git a/src/main/java/org/apache/bcel/classfile/NestMembers.java b/src/main/java/org/apache/bcel/classfile/NestMembers.java index 9f78b84e..3bcd945c 100644 --- a/src/main/java/org/apache/bcel/classfile/NestMembers.java +++ b/src/main/java/org/apache/bcel/classfile/NestMembers.java @@ -42,7 +42,7 @@ public final class NestMembers extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ NestMembers(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, (int[]) null, constant_pool); @@ -109,7 +109,7 @@ public final class NestMembers extends Attribute { * Dump NestMembers attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/PMGClass.java b/src/main/java/org/apache/bcel/classfile/PMGClass.java index 6831c8fb..652bab9d 100644 --- a/src/main/java/org/apache/bcel/classfile/PMGClass.java +++ b/src/main/java/org/apache/bcel/classfile/PMGClass.java @@ -41,7 +41,7 @@ public final class PMGClass extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ PMGClass(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -100,7 +100,7 @@ public final class PMGClass extends Attribute { * Dump source file attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java index 63a051f5..e84b6ce0 100644 --- a/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java +++ b/src/main/java/org/apache/bcel/classfile/ParameterAnnotationEntry.java @@ -53,7 +53,7 @@ public class ParameterAnnotationEntry implements Node { * Construct object from input stream. * * @param input Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ ParameterAnnotationEntry(final DataInput input, final ConstantPool constant_pool) throws IOException { final int annotation_table_length = input.readUnsignedShort(); diff --git a/src/main/java/org/apache/bcel/classfile/Signature.java b/src/main/java/org/apache/bcel/classfile/Signature.java index 8dbda61a..b79f6771 100644 --- a/src/main/java/org/apache/bcel/classfile/Signature.java +++ b/src/main/java/org/apache/bcel/classfile/Signature.java @@ -168,7 +168,7 @@ public final class Signature extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ Signature(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -223,7 +223,7 @@ public final class Signature extends Attribute { * Dump source file attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/SourceFile.java b/src/main/java/org/apache/bcel/classfile/SourceFile.java index 7dd11134..798dfdb6 100644 --- a/src/main/java/org/apache/bcel/classfile/SourceFile.java +++ b/src/main/java/org/apache/bcel/classfile/SourceFile.java @@ -42,7 +42,7 @@ public final class SourceFile extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ SourceFile(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -104,7 +104,7 @@ public final class SourceFile extends Attribute { * Dump source file attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/StackMap.java b/src/main/java/org/apache/bcel/classfile/StackMap.java index 1f06c256..6608f177 100644 --- a/src/main/java/org/apache/bcel/classfile/StackMap.java +++ b/src/main/java/org/apache/bcel/classfile/StackMap.java @@ -48,7 +48,7 @@ public final class StackMap extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ StackMap(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { this(name_index, length, (StackMapEntry[]) null, constant_pool); @@ -104,7 +104,7 @@ public final class StackMap extends Attribute { * Dump stack map table attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java index 560b3e5a..04b44588 100644 --- a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java +++ b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java @@ -49,7 +49,7 @@ public final class StackMapEntry implements Node, Cloneable * Construct object from input stream. * * @param input Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ StackMapEntry(final DataInput input, final ConstantPool constantPool) throws IOException { this(input.readByte() & 0xFF, -1, null, null, constantPool); @@ -176,7 +176,7 @@ public final class StackMapEntry implements Node, Cloneable * Dump stack map entry * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final DataOutputStream file ) throws IOException { file.write(frameType); diff --git a/src/main/java/org/apache/bcel/classfile/StackMapType.java b/src/main/java/org/apache/bcel/classfile/StackMapType.java index f2a84b3f..b7227c20 100644 --- a/src/main/java/org/apache/bcel/classfile/StackMapType.java +++ b/src/main/java/org/apache/bcel/classfile/StackMapType.java @@ -55,7 +55,7 @@ public final class StackMapType implements Cloneable { /** * Construct object from file stream. * @param file Input stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ StackMapType(final DataInput file, final ConstantPool constant_pool) throws IOException { this(file.readByte(), -1, constant_pool); @@ -83,7 +83,7 @@ public final class StackMapType implements Cloneable { * Dump type entries to file. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ public void dump( final DataOutputStream file ) throws IOException { file.writeByte(type); diff --git a/src/main/java/org/apache/bcel/classfile/Synthetic.java b/src/main/java/org/apache/bcel/classfile/Synthetic.java index d015f25a..493f7c4e 100644 --- a/src/main/java/org/apache/bcel/classfile/Synthetic.java +++ b/src/main/java/org/apache/bcel/classfile/Synthetic.java @@ -60,7 +60,7 @@ public final class Synthetic extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ Synthetic(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -114,7 +114,7 @@ public final class Synthetic extends Attribute { * Dump source file attribute to file stream in binary format. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/Unknown.java b/src/main/java/org/apache/bcel/classfile/Unknown.java index 3e484c66..813d93c9 100644 --- a/src/main/java/org/apache/bcel/classfile/Unknown.java +++ b/src/main/java/org/apache/bcel/classfile/Unknown.java @@ -78,7 +78,7 @@ public final class Unknown extends Attribute { * @param length Content length in bytes * @param input Input stream * @param constant_pool Array of constants - * @throws IOException + * @throws IOException if an I/O error occurs. */ Unknown(final int name_index, final int length, final DataInput input, final ConstantPool constant_pool) throws IOException { @@ -131,7 +131,7 @@ public final class Unknown extends Attribute { * Dump unknown bytes to file stream. * * @param file Output file stream - * @throws IOException + * @throws IOException if an I/O error occurs. */ @Override public void dump( final DataOutputStream file ) throws IOException { diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java b/src/main/java/org/apache/bcel/classfile/Utility.java index d465f5b2..19271ba8 100644 --- a/src/main/java/org/apache/bcel/classfile/Utility.java +++ b/src/main/java/org/apache/bcel/classfile/Utility.java @@ -930,7 +930,7 @@ public abstract class Utility { * * @param signature Method signature * @return String Array of argument types - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public static String[] methodSignatureArgumentTypes( final String signature ) throws ClassFormatException { @@ -944,7 +944,7 @@ public abstract class Utility { * @param signature Method signature * @param chopit flag that determines whether chopping is executed or not * @return String Array of argument types - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public static String[] methodSignatureArgumentTypes( final String signature, final boolean chopit ) throws ClassFormatException { @@ -973,7 +973,7 @@ public abstract class Utility { * * @param signature Method signature * @return String representation of method return type - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public static String methodSignatureReturnType( final String signature ) throws ClassFormatException { return methodSignatureReturnType(signature, true); @@ -986,7 +986,7 @@ public abstract class Utility { * @param signature Method signature * @param chopit flag that determines whether chopping is executed or not * @return String representation of method return type - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public static String methodSignatureReturnType( final String signature, final boolean chopit ) throws ClassFormatException { int index; @@ -1043,7 +1043,7 @@ public abstract class Utility { * @param chopit flag that determines whether chopping is executed or not * @param vars the LocalVariableTable for the method * @return Java type declaration - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file */ public static String methodSignatureToString( final String signature, final String name, final String access, final boolean chopit, final LocalVariableTable vars ) throws ClassFormatException { @@ -1469,7 +1469,7 @@ public abstract class Utility { * @param signature type signature * @param chopit flag that determines whether chopping is executed or not * @return string containing human readable type signature - * @throws ClassFormatException + * @throws ClassFormatException if a class is malformed or cannot be interpreted as a class file * @since 6.4.0 */ public static String typeSignatureToString( final String signature, final boolean chopit ) throws ClassFormatException {