public interface ClassDoc extends ProgramElementDoc, Type
Type
Modifier and Type | Method and Description |
---|---|
ConstructorDoc[] |
constructors()
Return
included
constructors in this class.
|
ConstructorDoc[] |
constructors(boolean filter)
Return constructors in this class, filtered to the specified
access
modifier option.
|
boolean |
definesSerializableFields()
Return true if Serializable fields are explicitly defined with
the special class member
serialPersistentFields . |
FieldDoc[] |
enumConstants()
Return the enum constants if this is an enum type.
|
FieldDoc[] |
fields()
Return
included
fields in this class or interface.
|
FieldDoc[] |
fields(boolean filter)
Return fields in this class or interface, filtered to the specified
access
modifier option.
|
ClassDoc |
findClass(String className)
Find the specified class or interface within the context of this class doc.
|
ClassDoc[] |
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.
|
PackageDoc[] |
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.
|
ClassDoc[] |
innerClasses()
Return
included
nested classes and interfaces within this class or interface.
|
ClassDoc[] |
innerClasses(boolean filter)
Return nested classes and interfaces within this class or interface
filtered to the specified
access
modifier option.
|
ClassDoc[] |
interfaces()
Return interfaces implemented by this class or interfaces extended
by this interface.
|
Type[] |
interfaceTypes()
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 or interface extends
java.io.Externalizable . |
boolean |
isSerializable()
Return true if this class implements or interface extends
java.io.Serializable . |
MethodDoc[] |
methods()
Return
included
methods in this class or interface.
|
MethodDoc[] |
methods(boolean filter)
Return methods in this class or interface, filtered to the specified
access
modifier option.
|
FieldDoc[] |
serializableFields()
Return the Serializable fields of this class or interface.
|
MethodDoc[] |
serializationMethods()
Return the serialization methods for this class or
interface.
|
boolean |
subclassOf(ClassDoc cd)
Test whether this class is a subclass of the specified class.
|
ClassDoc |
superclass()
Return the superclass of this class.
|
Type |
superclassType()
Return the superclass of this class.
|
TypeVariable[] |
typeParameters()
Return the formal type parameters of this class or interface.
|
ParamTag[] |
typeParamTags()
Return the type parameter tags of this class or interface.
|
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
asAnnotatedType, asAnnotationTypeDoc, asClassDoc, asParameterizedType, asTypeVariable, asWildcardType, dimension, getElementType, isPrimitive, qualifiedTypeName, simpleTypeName, toString, typeName
boolean isAbstract()
boolean isSerializable()
java.io.Serializable
.
Since java.io.Externalizable
extends
java.io.Serializable
,
Externalizable objects are also Serializable.boolean isExternalizable()
java.io.Externalizable
.MethodDoc[] serializationMethods()
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
objects for the Serializable
fields of this class or interface.definesSerializableFields()
,
SerialFieldTag
boolean definesSerializableFields()
serialPersistentFields
.serializableFields()
,
SerialFieldTag
ClassDoc superclass()
This method cannot accommodate certain generic type constructs.
The superclassType
method should be used instead.
superclassType()
Type superclassType()
ClassDoc
or a ParametrizedType
.boolean subclassOf(ClassDoc cd)
java.lang.Object
(we must keep this unexpected
behavior for compatibility reasons).cd
- the candidate superclass.ClassDoc[] interfaces()
This method cannot accommodate certain generic type constructs.
The interfaceTypes
method should be used instead.
interfaceTypes()
Type[] interfaceTypes()
ClassDoc
or a ParametrizedType
.TypeVariable[] typeParameters()
ParamTag[] typeParamTags()
FieldDoc[] fields()
FieldDoc[] fields(boolean filter)
filter
- Specify true to filter according to the specified access
modifier option.
Specify false to include all fields regardless of
access modifier option.FieldDoc[] enumConstants()
MethodDoc[] methods()
methods(true)
.MethodDoc[] methods(boolean filter)
filter
- Specify true to filter according to the specified access
modifier option.
Specify false to include all methods regardless of
access modifier option.ConstructorDoc[] constructors()
ConstructorDoc[] constructors(boolean filter)
filter
- Specify true to filter according to the specified access
modifier option.
Specify false to include all constructors regardless of
access modifier option.ClassDoc[] innerClasses()
nestedClasses()
,
as inner classes are technically non-static.) Anonymous and local classes
or interfaces are not included.ClassDoc[] innerClasses(boolean filter)
filter
- Specify true to filter according to the specified access
modifier option.
Specify false to include all nested classes regardless of
access modifier option.ClassDoc findClass(String className)
@Deprecated ClassDoc[] importedClasses()
@Deprecated PackageDoc[] importedPackages()
Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2019, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.