File	Doc	Category	Size	Date	Package
ClassDoc.java	API Doc	Java SE 5 API	11860	Fri Aug 26 14:54:54 BST 2005	com.sun.javadoc

ClassDoc

Fields Summary

Constructors Summary

Methods Summary
public com.sun.javadoc.ConstructorDoc[]	constructors() Return included constructors in this class. An array containing the default no-arg constructor is returned if no other constructors exist. Return empty array if this is an interface. return an array of ConstructorDoc objects representing the included constructors in this class.
public com.sun.javadoc.ConstructorDoc[]	constructors(boolean filter) Return constructors in this class, filtered to the specified access modifier option. Return an array containing the default no-arg constructor if no other constructors exist. param filter Specify true to filter according to the specified access modifier option. Specify false to include all constructors regardless of access modifier option. return an array of ConstructorDoc objects representing the included constructors in this class.
public boolean	definesSerializableFields() Return true if Serializable fields are explicitly defined with the special class member serialPersistentFields. see #serializableFields() see SerialFieldTag
public com.sun.javadoc.FieldDoc[]	enumConstants() Return the enum constants if this is an enum type. Return an empty array if there are no enum constants, or if this is not an enum type. return the enum constants if this is an enum type.
public com.sun.javadoc.FieldDoc[]	fields() Return included fields in this class or interface. Excludes enum constants if this is an enum type. return an array of FieldDoc objects representing the included fields in this class or interface.
public com.sun.javadoc.FieldDoc[]	fields(boolean filter) Return fields in this class or interface, filtered to the specified access modifier option. Excludes enum constants if this is an enum type. param filter Specify true to filter according to the specified access modifier option. Specify false to include all fields regardless of access modifier option. return an array of FieldDoc objects representing the included fields in this class or interface.
public com.sun.javadoc.ClassDoc	findClass(java.lang.String className) Find the specified class or interface within the context of this class doc. Search order: 1) qualified name, 2) nested in this class or interface, 3) in this package, 4) in the class imports, 5) in the package imports. Return the ClassDoc if found, null if not found.
public com.sun.javadoc.ClassDoc[]	importedClasses() Get the list of classes and interfaces declared as imported. These are called "single-type-import declarations" in the Java Language Specification. return an array of ClassDoc representing the imported classes. deprecated Import declarations are implementation details that should not be exposed here. In addition, not all imported classes are imported through single-type-import declarations.
public com.sun.javadoc.PackageDoc[]	importedPackages() Get the list of packages declared as imported. These are called "type-import-on-demand declarations" in the Java Language Specification. return an array of PackageDoc representing the imported packages. deprecated Import declarations are implementation details that should not be exposed here. In addition, this method's return type does not allow for all type-import-on-demand declarations to be returned.
public com.sun.javadoc.ClassDoc[]	innerClasses() Return included nested classes and interfaces within this class or interface. This includes both static and non-static nested classes. (This method should have been named nestedClasses(), as inner classes are technically non-static.) Anonymous and local classes or interfaces are not included. return an array of ClassDoc objects representing the included classes and interfaces defined in this class or interface.
public com.sun.javadoc.ClassDoc[]	innerClasses(boolean filter) Return nested classes and interfaces within this class or interface filtered to the specified access modifier option. This includes both static and non-static nested classes. Anonymous and local classes are not included. param filter Specify true to filter according to the specified access modifier option. Specify false to include all nested classes regardless of access modifier option. return a filtered array of ClassDoc objects representing the included classes and interfaces defined in this class or interface.
public com.sun.javadoc.Type[]	interfaceTypes() Return interfaces implemented by this class or interfaces extended by this interface. Includes only directly-declared interfaces, not inherited interfaces. Return an empty array if there are no interfaces. return an array of interfaces, each represented by a ClassDoc or a ParametrizedType. since 1.5
public com.sun.javadoc.ClassDoc[]	interfaces() Return interfaces implemented by this class or interfaces extended by this interface. Includes only directly-declared interfaces, not inherited interfaces. Return an empty array if there are no interfaces. This method cannot accommodate certain generic type constructs. The interfaceTypes method should be used instead. return an array of ClassDoc objects representing the interfaces. see #interfaceTypes
public boolean	isAbstract() Return true if this class is abstract. Return true for all interfaces.
public boolean	isExternalizable() Return true if this class implements or interface extends java.io.Externalizable.
public boolean	isSerializable() Return true if this class implements or interface extends java.io.Serializable. Since java.io.Externalizable extends java.io.Serializable, Externalizable objects are also Serializable.
public com.sun.javadoc.MethodDoc[]	methods() Return included methods in this class or interface. Same as methods(true). return an array of MethodDoc objects representing the included methods in this class or interface. Does not include constructors or annotation type elements.
public com.sun.javadoc.MethodDoc[]	methods(boolean filter) Return methods in this class or interface, filtered to the specified access modifier option. Does not include constructors or annotation type elements. param filter Specify true to filter according to the specified access modifier option. Specify false to include all methods regardless of access modifier option. return an array of MethodDoc objects representing the included methods in this class or interface.
public com.sun.javadoc.FieldDoc[]	serializableFields() Return the Serializable fields of this class or interface. 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. return an array of FieldDoc objects for the Serializable fields of this class or interface. see #definesSerializableFields() see SerialFieldTag
public com.sun.javadoc.MethodDoc[]	serializationMethods() Return the serialization methods for this class or interface. return an array of MethodDoc objects that represents the serialization methods for this class or interface.
public boolean	subclassOf(com.sun.javadoc.ClassDoc cd) Test whether this class is a subclass of the specified class. If this is an interface, return false for all classes except java.lang.Object (we must keep this unexpected behavior for compatibility reasons). param cd the candidate superclass. return true if cd is a superclass of this class.
public com.sun.javadoc.ClassDoc	superclass() Return the superclass of this class. Return null if this is an interface. This method cannot accommodate certain generic type constructs. The superclassType method should be used instead. return the ClassDoc for the superclass of this class, null if there is no superclass. see #superclassType
public com.sun.javadoc.Type	superclassType() Return the superclass of this class. Return null if this is an interface. A superclass is represented by either a ClassDoc or a ParametrizedType. return the superclass of this class, or null if there is no superclass. since 1.5
public com.sun.javadoc.ParamTag[]	typeParamTags() Return the type parameter tags of this class or interface. Return an empty array if there are none. return the type parameter tags of this class or interface. since 1.5
public com.sun.javadoc.TypeVariable[]	typeParameters() Return the formal type parameters of this class or interface. Return an empty array if there are none. return the formal type parameters of this class or interface. since 1.5