|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a java class and provides access to information about the class, the class' comment and tags, and the members of the class. A ClassDoc only exists if it was processed in this run of javadoc. References to classes which may or may not have been processed in this run are referred to using Type (which can be converted to ClassDoc, if possible).
Type
Method Summary | |
ConstructorDoc[] |
constructors()
Return constructors in class. |
boolean |
definesSerializableFields()
Return true if Serializable fields are explicitly defined with the special class member serialPersistentFields . |
FieldDoc[] |
fields()
Return fields in class. |
ClassDoc |
findClass(String className)
Find a class within the context of this class. |
ClassDoc[] |
importedClasses()
Get the list of classes declared as imported. |
PackageDoc[] |
importedPackages()
Get the list of packages declared as imported. |
ClassDoc[] |
innerClasses()
Return inner classes within this class. |
ClassDoc[] |
interfaces()
Return interfaces implemented by this class or interfaces extended by this interface. |
boolean |
isAbstract()
Return true if this class is abstract |
boolean |
isExternalizable()
Return true if this class implements java.io.Externalizable . |
boolean |
isSerializable()
Return true if this class implements java.io.Serializable . |
MethodDoc[] |
methods()
Return methods in class. |
FieldDoc[] |
serializableFields()
Return the Serializable fields of class. |
MethodDoc[] |
serializationMethods()
Return the serialization methods for this class. |
boolean |
subclassOf(ClassDoc cd)
Test whether this class is a subclass of the specified class. |
ClassDoc |
superclass()
Return the superclass of this class |
Methods inherited from interface com.sun.javadoc.ProgramElementDoc |
containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName |
Methods inherited from interface com.sun.javadoc.Doc |
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags |
Methods inherited from interface com.sun.javadoc.Type |
asClassDoc, dimension, qualifiedTypeName, toString, typeName |
Method Detail |
public boolean isAbstract()
public boolean isSerializable()
java.io.Serializable
.
Since java.io.Externalizable
extends
java.io.Serializable
,
Externalizable objects are also Serializable.
public boolean isExternalizable()
java.io.Externalizable
.
public MethodDoc[] serializationMethods()
MethodDoc
that represents
the serialization methods for this class.public FieldDoc[] serializableFields()
Return either a list of default fields documented by
serial
tag
or return a single FieldDoc
for
serialPersistentField
member.
There should be a serialField
tag for
each Serializable field defined by an ObjectStreamField
array component of serialPersistentField
.
FieldDoc
for the Serializable fields
of this class.definesSerializableFields()
,
SerialFieldTag
public boolean definesSerializableFields()
serialPersistentFields
.
serializableFields()
,
SerialFieldTag
public ClassDoc superclass()
public boolean subclassOf(ClassDoc cd)
cd
- the candidate superclass.
public ClassDoc[] interfaces()
public FieldDoc[] fields()
public MethodDoc[] methods()
public ConstructorDoc[] constructors()
public ClassDoc[] innerClasses()
public ClassDoc findClass(String className)
public ClassDoc[] importedClasses()
public PackageDoc[] importedPackages()
|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |