1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
/* ClassDoc.java -- Document a Java class or interface
Copyright (C) 1999 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
package com.sun.javadoc;
public interface ClassDoc extends ProgramElementDoc, Type
{
/**
* This method tests whether or not the class represented by this object
* is abstract.
*
* @return <code>true</code> if the class is abstract, <code>false</code>,
* otherwise.
*/
public abstract boolean
isAbstract();
/*************************************************************************/
/**
* This method tests whether or not the class represented by this object
* is serializable. That is, whether or not the class implements the
* <code>java.io.Serializable</code> interface. This includes classes
* which are externalizable.
*
* @return <code>true</code> if the class is serializable,
* <code>false</code> otherwise.
*/
public abstract boolean
isSerializable();
/*************************************************************************/
/**
* This method tests whether or not the class represented by this object
* is externalizable. That is, whether or not the class implements the
* <code>java.io.Externalizable</code> interface.
*
* @return <code>true</code> if the class is externalizable,
* <code>false</code> otherwise.
*/
public abstract boolean
isExternalizable();
/*************************************************************************/
/**
* This method returns the serialization methods for the class
* represented by this object. Is the custom readObject/writeObject
* methods?
*
* @return The serialization methods for this class.
*/
public abstract MethodDoc[]
serializationMethods();
/*************************************************************************/
/**
* This method returns the list of fields that are serialized in this
* class. This will return either the list of fields with an
* "@serial" declaration, or, if it exists, the
* <code>serialPersistentField</code> field.
*
* @return The list of serializable fields.
*/
public abstract FieldDoc[]
serializableFields();
/*************************************************************************/
/**
* This method tests whether or not the class represented by this object
* specifically defines its serializable fields in a
* <code>serialPersistentFields</code> field.
*
* @return <code>true</code> if this class explicitly defines its
* serializable fields, <code>false</code> otherwise.
*/
public abstract boolean
definesSerializableFields();
/*************************************************************************/
/**
* This method returns the superclass of the class represented by this
* object.
*
* @return The superclass of this class.
*/
public abstract ClassDoc
superclass();
/*************************************************************************/
/**
* This method tests whether or not the class represented by this object is
* a subclass of the specified class.
*
* @param cls The <code>ClassDoc</code> object of the class to test against.
*
* @return <code>true</code> if this class is a subclass of the specified
* class, <code>false</code> otherwise.
*/
public abstract boolean
subclassOf(ClassDoc cls);
/*************************************************************************/
/**
* This method returns this list of interfaces implemented (or in the case
* of interfaces, extended) by this class. This list will only include
* interfaces directly implemented by this class, not those inherited by
* interfaced implemented in this class.
*
* @return The list of interfaces this class implements.
*/
public abstract ClassDoc[]
interfaces();
/*************************************************************************/
/**
* This method returns the list of fields that are visible to the user in
* this class, or the list of all fields in this class.
*
* @param filtered if true, only return visible (included) fields;
* otherwise, return all fields.
*
* @return The list of visible fields in this class, or the list of
* all fields in this class.
*/
public abstract FieldDoc[]
fields(boolean filtered);
/*************************************************************************/
/**
* This method returns the list of fields that are visible to the user in
* this class. Does this depend on the -private -protected, etc flags
* passed to javadoc?
*
* @return The list of visible fields in this class.
*/
public abstract FieldDoc[]
fields();
/*************************************************************************/
/**
* This method returns either the list of methods that are visible to
* the user in the class represented by this object, or a list of all
* methods, excluding constructor methods.
*
* @param filtered if true, only return visible (included) methods;
* otherwise, return all methods.
*
* @return The list of all methods in this class, or the list of
* visible methods in this class.
*/
public abstract MethodDoc[]
methods(boolean filtered);
/*************************************************************************/
/**
* This method returns the list of methods that are visible to the user in
* the class represented by this object, excluding constructor methods.
*
* @return The list of visible methods in this class.
*/
public abstract MethodDoc[]
methods();
/*************************************************************************/
/**
* This method returns either the list of constructors that are
* visible to the user in the class represented by this object, or
* the list of all constructors.
*
* @param filtered if true, only return visible (included)
* constructors; otherwise, return all constructors.
*
* @return The list of all constructors in this class, or the list
* of visible constructors in this class.
*/
public abstract ConstructorDoc[]
constructors(boolean filtered);
/*************************************************************************/
/**
* This method returns the list of constructors that are visible to the user
* in the class represented by this object.
*
* @return The list visible constructors in this class.
*/
public abstract ConstructorDoc[]
constructors();
/*************************************************************************/
/**
* This method returns the list of inner classes that are visible to
* the user within the class represented by this object.
*
* @return The list of visible inner classes for this object.
*/
public abstract ClassDoc[]
innerClasses();
/*************************************************************************/
/**
* This method returns the list of all inner classes within the class
* represented by this object, or the list of visible inner classes
* in this class.
*
* @param filtered if true, only return visible (included) inner
* classes; otherwise, return all inner classes.
*
* @return The list of all inner classes for this object, or the list
* of visible inner classes.
*/
public abstract ClassDoc[]
innerClasses(boolean filtered);
/*************************************************************************/
/**
* This method returns a <code>ClassDoc</code> for the named class. The
* following search order is used:
* <p>
* <ol>
* <li>Fully qualified class name.
* <li>Inner classes within this class.
* <li>In the current package.
* <li>In the imports for this class.
* </ol>
*
* @param name The name of the class to find.
*
* @return The requested class, or <code>null</code> if the requested
* class cannot be found.
*/
public abstract ClassDoc
findClass(String name);
/*************************************************************************/
/**
* This method returns the list of classes that are imported. This
* excludes any imports of complete packages.
*
* @return The list of imported classes.
*/
public abstract ClassDoc[]
importedClasses();
/*************************************************************************/
/**
* This method returns the list of packages that are imported. This
* excludes any individual class imports.
*
* @return The list of imported packages.
*/
public abstract PackageDoc[]
importedPackages();
/*************************************************************************/
/**
* This method returns the formal type parameters of this class.
* The returned array is empty if the class does not represent a
* parameterized type.
*
* @return The list of type parameters.
* @since 1.5
*/
TypeVariable[]
typeParameters();
} // interface ClassDoc
|
