com.sun.javadoc
Interface ClassDoc

All Superinterfaces:

Comparable, Doc, ProgramElementDoc, Type

public interface ClassDoc

extends ProgramElementDoc, Type

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).

Since:

JDK1.2

See Also:

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, java.lang.Object)">compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText,