Skip to content

Commit 0949b7c

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent 2c791bd commit 0949b7c

File tree

294 files changed

+1359
-1365
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

294 files changed

+1359
-1365
lines changed

‎src/examples/ClassDumper.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ private void processConstantPool() throws IOException, ClassFormatException {
182182
/**
183183
* Constructs object from file stream.
184184
*
185-
* @param file Input stream
185+
* @param file Input stream.
186186
* @throws IOException if an I/O error occurs.
187187
* @throws ClassFormatException
188188
*/

‎src/examples/Mini/ASTExpr.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ public void dump(final String prefix) {
293293
/**
294294
* Second and third pass
295295
*
296-
* @return type of expression
296+
* @return type of expression.
297297
* @param expected type.
298298
*/
299299
public int eval(final int expected) {

‎src/examples/Mini/ASTIdent.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public void setName(final String name) {
122122
}
123123

124124
/**
125-
* @return identifier and line/column number of appearance
125+
* @return identifier and line/column number of appearance.
126126
*/
127127
@Override
128128
public String toString() {

‎src/examples/Mini/ASTInteger.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ void setValue(final int value) {
8585
}
8686

8787
/**
88-
* @return identifier and line/column number of appearance
88+
* @return identifier and line/column number of appearance.
8989
*/
9090
@Override
9191
public String toString() {

‎src/main/java/org/apache/bcel/ExceptionConst.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ public ExceptionConst() {
156156
/**
157157
* Creates a copy of the specified Exception Class array combined with any additional Exception classes.
158158
*
159-
* @param type the basic array type
160-
* @param extraClasses additional classes, if any
161-
* @return the merged array
159+
* @param type the basic array type.
160+
* @param extraClasses additional classes, if any.
161+
* @return the merged array.
162162
*/
163163
public static Class<?>[] createExceptions(final EXCS type, final Class<?>... extraClasses) {
164164
switch (type) {

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public abstract class Repository {
3838
/**
3939
* Adds clazz to repository if there isn't an equally named class already in there.
4040
*
41-
* @return old entry in repository
41+
* @return old entry in repository.
4242
*/
4343
public static JavaClass addClass(final JavaClass clazz) {
4444
final JavaClass old = repository.findClass(clazz.getClassName());
@@ -73,14 +73,14 @@ public static JavaClass[] getInterfaces(final String className) throws ClassNotF
7373
}
7474

7575
/**
76-
* @return currently used repository instance
76+
* @return currently used repository instance.
7777
*/
7878
public static org.apache.bcel.util.Repository getRepository() {
7979
return repository;
8080
}
8181

8282
/**
83-
* @return list of super classes of clazz in ascending order, that is, Object is always the last element
83+
* @return list of super classes of clazz in ascending order, that is, Object is always the last element.
8484
* @throws ClassNotFoundException if any of the superclasses can't be found
8585
*/
8686
public static JavaClass[] getSuperClasses(final JavaClass clazz) throws ClassNotFoundException {
@@ -96,31 +96,31 @@ public static JavaClass[] getSuperClasses(final String className) throws ClassNo
9696
}
9797

9898
/**
99-
* @return true, if clazz is an implementation of interface inter
99+
* @return true, if clazz is an implementation of interface inter.
100100
* @throws ClassNotFoundException if any superclasses or superinterfaces of clazz can't be found
101101
*/
102102
public static boolean implementationOf(final JavaClass clazz, final JavaClass inter) throws ClassNotFoundException {
103103
return clazz.implementationOf(inter);
104104
}
105105

106106
/**
107-
* @return true, if clazz is an implementation of interface inter
107+
* @return true, if clazz is an implementation of interface inter.
108108
* @throws ClassNotFoundException if inter or any superclasses or superinterfaces of clazz can't be found
109109
*/
110110
public static boolean implementationOf(final JavaClass clazz, final String inter) throws ClassNotFoundException {
111111
return implementationOf(clazz, lookupClass(inter));
112112
}
113113

114114
/**
115-
* @return true, if clazz is an implementation of interface inter
115+
* @return true, if clazz is an implementation of interface inter.
116116
* @throws ClassNotFoundException if clazz or any superclasses or superinterfaces of clazz can't be found
117117
*/
118118
public static boolean implementationOf(final String clazz, final JavaClass inter) throws ClassNotFoundException {
119119
return implementationOf(lookupClass(clazz), inter);
120120
}
121121

122122
/**
123-
* @return true, if clazz is an implementation of interface inter
123+
* @return true, if clazz is an implementation of interface inter.
124124
* @throws ClassNotFoundException if clazz, inter, or any superclasses or superinterfaces of clazz can't be found
125125
*/
126126
public static boolean implementationOf(final String clazz, final String inter) throws ClassNotFoundException {
@@ -130,31 +130,31 @@ public static boolean implementationOf(final String clazz, final String inter) t
130130
/**
131131
* Equivalent to runtime "instanceof" operator.
132132
*
133-
* @return true, if clazz is an instance of superclass
133+
* @return true, if clazz is an instance of superclass.
134134
* @throws ClassNotFoundException if any superclasses or superinterfaces of clazz can't be found
135135
*/
136136
public static boolean instanceOf(final JavaClass clazz, final JavaClass superclass) throws ClassNotFoundException {
137137
return clazz.instanceOf(superclass);
138138
}
139139

140140
/**
141-
* @return true, if clazz is an instance of superclass
141+
* @return true, if clazz is an instance of superclass.
142142
* @throws ClassNotFoundException if superclass can't be found
143143
*/
144144
public static boolean instanceOf(final JavaClass clazz, final String superclass) throws ClassNotFoundException {
145145
return instanceOf(clazz, lookupClass(superclass));
146146
}
147147

148148
/**
149-
* @return true, if clazz is an instance of superclass
149+
* @return true, if clazz is an instance of superclass.
150150
* @throws ClassNotFoundException if clazz can't be found
151151
*/
152152
public static boolean instanceOf(final String clazz, final JavaClass superclass) throws ClassNotFoundException {
153153
return instanceOf(lookupClass(clazz), superclass);
154154
}
155155

156156
/**
157-
* @return true, if clazz is an instance of superclass
157+
* @return true, if clazz is an instance of superclass.
158158
* @throws ClassNotFoundException if either clazz or superclass can't be found
159159
*/
160160
public static boolean instanceOf(final String clazz, final String superclass) throws ClassNotFoundException {
@@ -165,7 +165,7 @@ public static boolean instanceOf(final String clazz, final String superclass) th
165165
* Tries to find class source using the internal repository instance.
166166
*
167167
* @see Class
168-
* @return JavaClass object for given runtime class
168+
* @return JavaClass object for given runtime class.
169169
* @throws ClassNotFoundException if the class could not be found or parsed correctly
170170
*/
171171
public static JavaClass lookupClass(final Class<?> clazz) throws ClassNotFoundException {
@@ -175,7 +175,7 @@ public static JavaClass lookupClass(final Class<?> clazz) throws ClassNotFoundEx
175175
/**
176176
* Lookups class somewhere found on your CLASSPATH, or whereever the repository instance looks for it.
177177
*
178-
* @return class object for given fully qualified class name
178+
* @return class object for given fully qualified class name.
179179
* @throws ClassNotFoundException if the class could not be found or parsed correctly
180180
*/
181181
public static JavaClass lookupClass(final String className) throws ClassNotFoundException {

‎src/main/java/org/apache/bcel/classfile/Annotations.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ public abstract class Annotations extends Attribute implements Iterable<Annotati
3939
/**
4040
* Constructs an instance.
4141
*
42-
* @param annotationType the subclass type of the annotation
43-
* @param nameIndex Index pointing to the name <em>Code</em>
44-
* @param length Content length in bytes
45-
* @param annotationTable the actual annotations
46-
* @param constantPool Array of constants
47-
* @param isRuntimeVisible whether this Annotation visible at runtime
42+
* @param annotationType the subclass type of the annotation.
43+
* @param nameIndex Index pointing to the name <em>Code</em>.
44+
* @param length Content length in bytes.
45+
* @param annotationTable the actual annotations.
46+
* @param constantPool Array of constants.
47+
* @param isRuntimeVisible whether this Annotation visible at runtime.
4848
*/
4949
public Annotations(final byte annotationType, final int nameIndex, final int length, final AnnotationEntry[] annotationTable,
5050
final ConstantPool constantPool, final boolean isRuntimeVisible) {
@@ -56,12 +56,12 @@ public Annotations(final byte annotationType, final int nameIndex, final int len
5656
/**
5757
* Constructs an instance.
5858
*
59-
* @param annotationType the subclass type of the annotation
60-
* @param nameIndex Index pointing to the name <em>Code</em>
61-
* @param length Content length in bytes
62-
* @param input Input stream
63-
* @param constantPool Array of constants
64-
* @param isRuntimeVisible whether this Annotation visible at runtime
59+
* @param annotationType the subclass type of the annotation.
60+
* @param nameIndex Index pointing to the name <em>Code</em>.
61+
* @param length Content length in bytes.
62+
* @param input Input stream.
63+
* @param constantPool Array of constants.
64+
* @param isRuntimeVisible whether this Annotation visible at runtime.
6565
* @throws IOException if an I/O error occurs.
6666
*/
6767
Annotations(final byte annotationType, final int nameIndex, final int length, final DataInput input, final ConstantPool constantPool,

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ public static void addAttributeReader(final String name, final AttributeReader a
8383
* Add an Attribute reader capable of parsing (user-defined) attributes named "name". You should not add readers for the
8484
* standard attributes such as "LineNumberTable", because those are handled internally.
8585
*
86-
* @param name the name of the attribute as stored in the class file
87-
* @param unknownAttributeReader the reader object
86+
* @param name the name of the attribute as stored in the class file.
87+
* @param unknownAttributeReader the reader object.
8888
*/
8989
public static void addAttributeReader(final String name, final UnknownAttributeReader unknownAttributeReader) {
9090
READERS.put(name, unknownAttributeReader);
@@ -107,9 +107,9 @@ protected static void println(final String msg) {
107107
*
108108
* @see Field
109109
* @see Method
110-
* @param dataInput Input stream
111-
* @param constantPool Array of constants
112-
* @return Attribute
110+
* @param dataInput Input stream.
111+
* @param constantPool Array of constants.
112+
* @return Attribute.
113113
* @throws IOException if an I/O error occurs.
114114
* @since 6.0
115115
*/
@@ -211,9 +211,9 @@ public static Attribute readAttribute(final DataInput dataInput, final ConstantP
211211
*
212212
* @see Field
213213
* @see Method
214-
* @param dataInputStream Input stream
215-
* @param constantPool Array of constants
216-
* @return Attribute
214+
* @param dataInputStream Input stream.
215+
* @param constantPool Array of constants.
216+
* @return Attribute.
217217
* @throws IOException if an I/O error occurs.
218218
*/
219219
public static Attribute readAttribute(final DataInputStream dataInputStream, final ConstantPool constantPool) throws IOException {
@@ -242,7 +242,7 @@ public static void removeAttributeReader(final String name) {
242242
protected int length; // Content length of attribute field TODO make private (has getter & setter).
243243

244244
/**
245-
* @deprecated (since 6.0) will be made private; do not access directly, use getter/setter
245+
* @deprecated (since 6.0) will be made private; do not access directly, use getter/setter.
246246
*/
247247
@java.lang.Deprecated
248248
protected byte tag; // Tag to distinguish subclasses TODO make private & final; supposed to be immutable.

‎src/main/java/org/apache/bcel/classfile/AttributeReader.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* Attribute.addAttributeReader method. These factory objects should implement this interface.
2424
*
2525
* @see Attribute
26-
* @deprecated Use UnknownAttributeReader instead.
26+
* @deprecated Use {@link UnknownAttributeReader} instead.
2727
*/
2828
@java.lang.Deprecated
2929
public interface AttributeReader {
@@ -36,13 +36,12 @@ public interface AttributeReader {
3636
* @param nameIndex An index into the constant pool, indexing a ConstantUtf8 that represents the name of the attribute.
3737
* @param length The length of the data contained in the attribute. This is written into the constant pool and should
3838
* agree with what the factory expects the length to be.
39-
*
4039
* @param file This is the data input stream that the factory needs to read its data from.
4140
* @param constantPool This is the constant pool associated with the Attribute that we are constructing.
4241
* @return The user-defined AttributeReader should take this data and use it to construct an attribute. In the case of
4342
* errors, a null can be returned which will cause the parsing of the class file to fail.
4443
*
45-
* @see Attribute#addAttributeReader( String, AttributeReader )
44+
* @see Attribute#addAttributeReader(String,AttributeReader)
4645
*/
4746
Attribute createAttribute(int nameIndex, int length, java.io.DataInputStream file, ConstantPool constantPool);
4847
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public BootstrapMethod(final BootstrapMethod c) {
5757
/**
5858
* Constructs object from input stream.
5959
*
60-
* @param input Input stream
60+
* @param input Input stream.
6161
* @throws IOException if an I/O error occurs.
6262
*/
6363
BootstrapMethod(final DataInput input) throws IOException {

0 commit comments

Comments
 (0)