Package gw.gosudoc.com.sun.javadoc
Interface ClassDoc
- All Superinterfaces:
Comparable<Object>
,Doc
,ProgramElementDoc
,Type
- All Known Subinterfaces:
AnnotationTypeDoc
- All Known Implementing Classes:
AnnotationTypeDocImpl
,ClassDocImpl
Deprecated.
Represents a java class or interface and provides access to
information about the class, the class's 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:
- 1.2
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Return included constructors in this class.constructors
(boolean filter) Deprecated.Return constructors in this class, filtered to the specified access modifier option.boolean
Deprecated.Return true if Serializable fields are explicitly defined with the special class memberserialPersistentFields
.FieldDoc[]
Deprecated.Return the enum constants if this is an enum type.FieldDoc[]
fields()
Deprecated.Return included fields in this class or interface.FieldDoc[]
fields
(boolean filter) Deprecated.Return fields in this class or interface, filtered to the specified access modifier option.Deprecated.Find the specified class or interface within the context of this class doc.ClassDoc[]
Deprecated.Import declarations are implementation details that should not be exposed here.Deprecated.Import declarations are implementation details that should not be exposed here.ClassDoc[]
Deprecated.Return included nested classes and interfaces within this class or interface.ClassDoc[]
innerClasses
(boolean filter) Deprecated.Return nested classes and interfaces within this class or interface filtered to the specified access modifier option.ClassDoc[]
Deprecated.Return interfaces implemented by this class or interfaces extended by this interface.Type[]
Deprecated.Return interfaces implemented by this class or interfaces extended by this interface.boolean
Deprecated.Return true if this class is abstract.boolean
Deprecated.Return true if this class implements or interface extendsjava.io.Externalizable
.boolean
Deprecated.Return true if this class implements or interface extendsjava.io.Serializable
.methods()
Deprecated.Return included methods in this class or interface.methods
(boolean filter) Deprecated.Return methods in this class or interface, filtered to the specified access modifier option.FieldDoc[]
Deprecated.Return the Serializable fields of this class or interface.Deprecated.Return the serialization methods for this class or interface.boolean
subclassOf
(ClassDoc cd) Deprecated.Test whether this class is a subclass of the specified class.Deprecated.Return the superclass of this class.Deprecated.Return the superclass of this class.Deprecated.Return the formal type parameters of this class or interface.ParamTag[]
Deprecated.Return the type parameter tags of this class or interface.Methods inherited from interface gw.gosudoc.com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
Methods inherited from interface gw.gosudoc.com.sun.javadoc.ProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
Methods inherited from interface gw.gosudoc.com.sun.javadoc.Type
asAnnotatedType, asAnnotationTypeDoc, asClassDoc, asParameterizedType, asTypeVariable, asWildcardType, dimension, getElementType, isPrimitive, qualifiedTypeName, simpleTypeName, toString, typeName
-
Method Details
-
isAbstract
boolean isAbstract()Deprecated.Return true if this class is abstract. Return true for all interfaces.- Returns:
- true if this class is abstract. Return true for all interfaces.
-
isSerializable
boolean isSerializable()Deprecated.Return true if this class implements or interface extendsjava.io.Serializable
. Sincejava.io.Externalizable
extendsjava.io.Serializable
, Externalizable objects are also Serializable.- Returns:
- true if this class implements or interface extends
java.io.Serializable
.
-
isExternalizable
boolean isExternalizable()Deprecated.Return true if this class implements or interface extendsjava.io.Externalizable
.- Returns:
- true if this class implements or interface extends
java.io.Externalizable
.
-
serializationMethods
MethodDoc[] serializationMethods()Deprecated.Return the serialization methods for this class or interface.- Returns:
- an array of MethodDoc objects that represents the serialization methods for this class or interface.
-
serializableFields
FieldDoc[] serializableFields()Deprecated.Return the Serializable fields of this class or interface.Return either a list of default fields documented by
serial
tag
or return a singleFieldDoc
forserialPersistentField
member. There should be aserialField
tag for each Serializable field defined by anObjectStreamField
array component ofserialPersistentField
.- Returns:
- an array of
FieldDoc
objects for the Serializable fields of this class or interface. - See Also:
-
definesSerializableFields
boolean definesSerializableFields()Deprecated.Return true if Serializable fields are explicitly defined with the special class memberserialPersistentFields
.- Returns:
- true if Serializable fields are explicitly defined with
the special class member
serialPersistentFields
. - See Also:
-
superclass
ClassDoc superclass()Deprecated.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.- Returns:
- the ClassDoc for the superclass of this class, null if there is no superclass.
- See Also:
-
superclassType
Type superclassType()Deprecated.Return the superclass of this class. Return null if this is an interface. A superclass is represented by either aClassDoc
or aParametrizedType
.- Returns:
- the superclass of this class, or null if there is no superclass.
- Since:
- 1.5
-
subclassOf
Deprecated.Test whether this class is a subclass of the specified class. If this is an interface, return false for all classes exceptjava.lang.Object
(we must keep this unexpected behavior for compatibility reasons).- Parameters:
cd
- the candidate superclass.- Returns:
- true if cd is a superclass of this class.
-
interfaces
ClassDoc[] interfaces()Deprecated.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.- Returns:
- an array of ClassDoc objects representing the interfaces.
- See Also:
-
interfaceTypes
Type[] interfaceTypes()Deprecated.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.- Returns:
- an array of interfaces, each represented by a
ClassDoc
or aParametrizedType
. - Since:
- 1.5
-
typeParameters
TypeVariable[] typeParameters()Deprecated.Return the formal type parameters of this class or interface. Return an empty array if there are none.- Returns:
- the formal type parameters of this class or interface.
- Since:
- 1.5
-
typeParamTags
ParamTag[] typeParamTags()Deprecated.Return the type parameter tags of this class or interface. Return an empty array if there are none.- Returns:
- the type parameter tags of this class or interface.
- Since:
- 1.5
-
fields
FieldDoc[] fields()Deprecated.Return included fields in this class or interface. Excludes enum constants if this is an enum type.- Returns:
- an array of FieldDoc objects representing the included fields in this class or interface.
-
fields
Deprecated.Return fields in this class or interface, filtered to the specified access modifier option. Excludes enum constants if this is an enum type.- Parameters:
filter
- Specify true to filter according to the specified access modifier option. Specify false to include all fields regardless of access modifier option.- Returns:
- an array of FieldDoc objects representing the included fields in this class or interface.
-
enumConstants
FieldDoc[] enumConstants()Deprecated.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.- Returns:
- the enum constants if this is an enum type.
-
methods
MethodDoc[] methods()Deprecated.Return included methods in this class or interface. Same asmethods(true)
.- Returns:
- an array of MethodDoc objects representing the included methods in this class or interface. Does not include constructors or annotation type elements.
-
methods
Deprecated.Return methods in this class or interface, filtered to the specified access modifier option. Does not include constructors or annotation type elements.- Parameters:
filter
- Specify true to filter according to the specified access modifier option. Specify false to include all methods regardless of access modifier option.- Returns:
- an array of MethodDoc objects representing the included methods in this class or interface.
-
constructors
ConstructorDoc[] constructors()Deprecated.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.- Returns:
- an array of ConstructorDoc objects representing the included constructors in this class.
-
constructors
Deprecated.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.- Parameters:
filter
- Specify true to filter according to the specified access modifier option. Specify false to include all constructors regardless of access modifier option.- Returns:
- an array of ConstructorDoc objects representing the included constructors in this class.
-
innerClasses
ClassDoc[] innerClasses()Deprecated.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 namednestedClasses()
, as inner classes are technically non-static.) Anonymous and local classes or interfaces are not included.- Returns:
- an array of ClassDoc objects representing the included classes and interfaces defined in this class or interface.
-
innerClasses
Deprecated.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.- Parameters:
filter
- Specify true to filter according to the specified access modifier option. Specify false to include all nested classes regardless of access modifier option.- Returns:
- a filtered array of ClassDoc objects representing the included classes and interfaces defined in this class or interface.
-
findClass
Deprecated.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.- Parameters:
className
- Specify the class name to find as a String.- Returns:
- the ClassDoc if found, null if not found.
-
importedClasses
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.Get the list of classes and interfaces declared as imported. These are called "single-type-import declarations" in The Java™ Language Specification.- Returns:
- an array of ClassDoc representing the imported classes.
-
importedPackages
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.Get the list of packages declared as imported. These are called "type-import-on-demand declarations" in The Java™ Language Specification.- Returns:
- an array of PackageDoc representing the imported packages.
-
jdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.